Added more javadocs

kuali · Oct 23, 2008 · 211ed20 · 211ed20
1 parent 4cf533c
commit 211ed20
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/src/net/sourceforge/schemaspy/util/HtmlEncoder.java b/src/net/sourceforge/schemaspy/util/HtmlEncoder.java
@@ -44,12 +44,18 @@ public static String encodeToken(String str) {
         return (result == null) ? str : result;
     }
 
+    /**
+     * Returns an HTML-encoded version of the specified string
+     * 
+     * @param str
+     * @return
+     */
     public static String encodeString(String str) {
         int len = str.length();
-    	StringBuilder s = new StringBuilder(len * 2);
+    	StringBuilder buf = new StringBuilder(len * 2); // x2 should limit # of reallocs
     	for (int i = 0; i < len; i++) {
-			s.append(encodeToken(str.charAt(i)));
+			buf.append(encodeToken(str.charAt(i)));
 		}
-    	return s.toString();
+    	return buf.toString();
     }
 }