Changeset 2151 for FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/FCKeditor.java

Timestamp:

2008-07-03 00:03:15 (6 months ago)

Author:

mosipov

Message:

JavaDoc issues

Files:

• FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/FCKeditor.java (modified) (7 diffs)

FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/FCKeditor.java

@@ -30 +30 @@
 
 /**
- * FCKeditor class.<br />
- * It creates the html code for the FCKeditor based on the following things:
+ * Java represantation of the FCKeditor. This class creates the html code for
+ * the FCKeditor based on the following things:
  * <ul>
  * <li>browser capabilities</li>
@@ -107 +107 @@
          * Set the unique name of the editor
          * 
-         * @param value
+         * @param instanceName
          *            name
          */
-        public void setInstanceName(final String value) {
-                instanceName = value;
+        public void setInstanceName(final String instanceName) {
+                this.instanceName = instanceName;
         }
 
@@ -129 +129 @@
          * path from the context (e.g. /fckeditor).
          * 
-         * @param value
+         * @param basePath
          *            path
          */
-        public void setBasePath(final String value) {
-                basePath = value;
+        public void setBasePath(final String basePath) {
+                this.basePath = basePath;
         }
 
@@ -139 +139 @@
          * Set the name of the toolbar to display
          * 
-         * @param value
+         * @param toolbarSet
          *            toolbar name
          */
-        public void setToolbarSet(final String value) {
-                toolbarSet = value;
+        public void setToolbarSet(final String toolbarSet) {
+                this.toolbarSet = toolbarSet;
         }
 
@@ -149 +149 @@
          * Set the width of the textarea
          * 
-         * @param value
+         * @param width
          *            width
          */
-        public void setWidth(final String value) {
-                width = value;
+        public void setWidth(final String width) {
+                this.width = width;
         }
 
@@ -159 +159 @@
          * Set the height of the textarea
          * 
-         * @param value
+         * @param height
          *            height
          */
-        public void setHeight(final String value) {
-                height = value;
+        public void setHeight(final String height) {
+                this.height = height;
         }
 
@@ -176 +176 @@
                 return config;
         }
-
-        /**
-         * Set the advanced configuration set.
-         * 
-         * @param value
+        /**
+         * Set the advanced configuation set.
+         * 
+         * @param config
          *            configuration collection
          */
-        public void setConfig(FCKeditorConfig value) {
-                config = value;
+        public void setConfig(FCKeditorConfig config) {
+                this.config = config;
         }
 
         /**
          * Escape base XML entities as specified <a
-         * href="http://en.wikipedia.org/wiki/Xml#Entity_references">here</a>
-         * 
-         * @param txt
+         * href="http://en.wikipedia.org/wiki/Xml#Entity_references">here</a>.
+         * 
+         * @param str
          *            Text to escape.
          * @return Escaped text.
          */
-        private String escapeXml(String txt) {
-                if (Utils.isEmpty(txt))
-                        return txt;
-                txt = txt.replaceAll("&", "&#38;");
-                txt = txt.replaceAll("<", "&#60;");
-                txt = txt.replaceAll(">", "&#62;");
-                txt = txt.replaceAll("\"", "&#34;");
-                txt = txt.replaceAll("'", "&#39;");
-                return txt;
-        }
-
-        /*
-         * (non-Javadoc)
-         * @see #createHtml()
-         */
-        public String create() {
-                return createHtml();
+        private String escapeXml(String str) {
+                if (Utils.isEmpty(str))
+                        return str;
+                
+                /*
+                 * TODO Strings are inefficent. It should be done like in Commons Lang
+                 * 2.4 StringUtils#replaceEach(String, String[], String[])
+                 */
+                str = str.replaceAll("&", "&#38;");
+                str = str.replaceAll("<", "&#60;");
+                str = str.replaceAll(">", "&#62;");
+                str = str.replaceAll("\"", "&#34;");
+                str = str.replaceAll("'", "&#39;");
+                return str;
         }
         
         /*
          * (non-Javadoc)
+         * 
+         * @see #createHtml()
+         */
+        /**
+         * This method simply wraps to {@link #createHtml()}.
          * @see #createHtml()
          */