[Japi-cvs] SF.net SVN: japi: [296] tools/string2bytes/trunk/src/net/sf/japi/ string2bytes/String2Bytes.java

[<chr...@us...>]

Revision: 296
          http://svn.sourceforge.net/japi/?rev=296&view=rev
Author:   christianhujer
Date:     2007-01-14 13:01:34 -0800 (Sun, 14 Jan 2007)

Log Message:
-----------
Added some missing documentation.

Modified Paths:
--------------
    tools/string2bytes/trunk/src/net/sf/japi/string2bytes/String2Bytes.java

Modified: tools/string2bytes/trunk/src/net/sf/japi/string2bytes/String2Bytes.java
===================================================================
--- tools/string2bytes/trunk/src/net/sf/japi/string2bytes/String2Bytes.java	2007-01-14 17:52:45 UTC (rev 295)
+++ tools/string2bytes/trunk/src/net/sf/japi/string2bytes/String2Bytes.java	2007-01-14 21:01:34 UTC (rev 296)
@@ -180,6 +180,10 @@
         encoding.setSelectedItem(Charset.forName(ACTION_FACTORY.getString("encoding.default")).name());
     }
 
+    /**
+     * Creates the panel which holds the settings.
+     * @return Newly created panel which holds the settings.
+     */
     private JPanel createSettingsPanel() {
         final JPanel settingsPanel = new JPanel();
         settingsPanel.setBorder(BorderFactory.createTitledBorder("Settings"));
@@ -187,6 +191,10 @@
         return settingsPanel;
     }
 
+    /**
+     * Creates the panel which allows the user to select the encoding.
+     * @return Newly created panel for selecting the encoding.
+     */
     private JPanel createEncodingPanel() {
         encoding.setSelectedItem(PREFS.get("encoding", ACTION_FACTORY.getString("encoding.default")));
         encoding.setEditable(true);
@@ -242,6 +250,10 @@
         return outputPanel;
     }
 
+    /**
+     * Creates the command panel which holds the button to perform the conversion.
+     * @return Newly created command panel.
+     */
     private JPanel createCommandPanel() {
         final JPanel commandPanel = new JPanel();
         commandPanel.setBorder(BorderFactory.createTitledBorder("Commands"));
@@ -256,25 +268,46 @@
         }
     }
 
+    /**
+     * Main program.
+     * @param args Command line arguments (ignored)
+     */
     public static void main(final String... args) {
         new String2Bytes();
     }
 
+    /**
+     * Get whether the clipboard should be used as the source for input.
+     * @return <code>true</code> if the clipboard should be used as the source for input, otherwise <code>false</code>.
+     */
     public boolean isUsingClipboardForInput() {
         return usingClipboardForInput;
     }
 
+    /**
+     * Sets whether the clipboard should be used as the source for input.
+     * @param usingClipboardForInput <code>true</code> if the clipboard should be used as the source for input, otherwise <code>false</code>.
+     */
     public void setUsingClipboardForInput(final boolean usingClipboardForInput) {
         this.usingClipboardForInput = usingClipboardForInput;
         PREFS.putBoolean("usingClipboardForInput", usingClipboardForInput);
     }
 
+    /**
+     * Get whether the clipboard should be used as the destination for output.
+     * @return <code>true</code> if the clipboard should be used as the destination for output, otherwise <code>false</code>.
+     */
     public boolean isUsingClipboardForOutput() {
         return usingClipboardForOutput;
     }
 
+    /**
+     * Sets whether the clipboard should be used as the destination for output.
+     * @param usingClipboardForOutput <code>true</code> if the clipboard should be used as the destination for output, otherwise <code>false</code>.
+     */
     public void setUsingClipboardForOutput(final boolean usingClipboardForOutput) {
         this.usingClipboardForOutput = usingClipboardForOutput;
         PREFS.putBoolean("usingClipboardForOutput", usingClipboardForOutput);
     }
+
 } // class ConversionAction


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.