svn commit: r1489527 - /commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Charsets.java

[sebb]

Author: sebb
Date: Tue Jun  4 17:22:23 2013
New Revision: 1489527

URL: http://svn.apache.org/r1489527
Log:
Javadoc

Modified:
    
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Charsets.java

Modified: 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Charsets.java
URL: 
http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Charsets.java?rev=1489527&r1=1489526&r2=1489527&view=diff
==============================================================================
--- 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Charsets.java
 (original)
+++ 
commons/proper/net/trunk/src/main/java/org/apache/commons/net/util/Charsets.java
 Tue Jun  4 17:22:23 2013
@@ -21,6 +21,16 @@ public class Charsets {
         return charsetName == null ? Charset.defaultCharset() : 
Charset.forName(charsetName);
     }
 
+    /**
+     * Returns a charset object for the given charset name.
+     * 
+     * @param charsetName
+     *            The name of the requested charset; may be a canonical name, 
an alias, or null. 
+     *            If null, return the default charset.
+     * @param defaultCharsetName the charset name to use if the requested 
charset is null
+     *
+     * @return A charset object for the named charset
+     */
     public static Charset toCharset(String charsetName, String 
defaultCharsetName) {
         return charsetName == null ? Charset.forName(defaultCharsetName) : 
Charset.forName(charsetName);
     }