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

Timestamp:

2008-06-23 00:00:48 (7 months ago)

Author:

mosipov

Message:

NEW - #1968: Javadoc issues

Files:

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

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

@@ -30 +30 @@
 
 /**
- * FCKeditor control class.<br>
- * 
+ * FCKeditor class.<br />
  * It creates the html code for the FCKeditor based on the following things:
  * <ul>
- * <li>browser's capabilities</li>
+ * <li>browser capabilities</li>
  * <li>different properties settings managed by the {@link PropertiesLoader}</li>
- * <li>settings from the 'caller', eg. jsp-pages</li>
+ * <li>settings from the FCKeditor tag, template engines and other systems</li>
  * </ul>
  * 
@@ -57 +56 @@
         /**
          * Main constructor.<br>
-         * All important settings are done here and will be preset by there defaults taken from
-         * {@link PropertiesLoader}.
+         * All important settings are done here and will be preset by the defaults
+         * taken from {@link PropertiesLoader}.
          * 
          * @param request
@@ -116 +115 @@
 
         /**
-         * Set the initial value to be edited.<br>
-         * In HTML code
+         * Set the initial value to be edited as HTML markup.
          * 
          * @param value
@@ -127 +125 @@
 
         /**
-         * Set the dir where the FCKeditor files reside on the server.<br>
-         * <b>Remarks</b>:<br>
-         * Avoid using relative paths. It is preferable to set the base path starting from the root (/).<br>
-         * Always finish the path with a slash (/).
+         * Sets the directory where the FCKeditor resides on the server.<br />
+         * <strong>Remarks</strong>: Avoid using relative paths. Use an absolute
+         * path from the context (e.g. /fckeditor).
          * 
          * @param value
@@ -170 +167 @@
 
         /**
-         * Get the advanced configuation set.<br>
-         * Adding element to this collection you can override the settings specified in the config.js
-         * file.
+         * Get the advanced configuation set.<br />
+         * By adding elements to this collection you can override the settings
+         * specified in the config.js file.
          * 
          * @return configuration collection
@@ -190 +187 @@
         }
 
+        /**
+         * Escape base XML entities as specified <a
+         * href="http://en.wikipedia.org/wiki/Xml#Entity_references">here</a>
+         * 
+         * @param txt
+         *            Text to escape.
+         * @return Escaped text.
+         */
         private String escapeXml(String txt) {
                 if (Utils.isEmpty(txt))
                         return txt;
+                // TODO Strings are inefficent, use StringBuffer instead
                 txt = txt.replaceAll("&", "&#38;");
                 txt = txt.replaceAll("<", "&#60;");
@@ -201 +207 @@
         }
 
-        /**
-         * Minimum implementation, see ticket #27 for detailed information.
+        /*
+         * (non-Javadoc)
+         * @see #createHtml()
          */
         public String create() {
                 return createHtml();
         }
-
+        
+        /*
+         * (non-Javadoc)
+         * @see #createHtml()
+         */
         @Override
         public String toString() {
@@ -214 +225 @@
 
         /**
-         * Generate the HTML Code for the editor. <br>
-         * Evalute the browser capabilities and generate the editor if compatible, or a simple textarea
-         * otherwise.
-         * 
-         * @return html code
+         * Minimum implementation, see ticket #27 for detailed information. Generate
+         * the HTML Code for the editor.<br />
+         * Evaluate the browser capabilities and generate the editor if compatible,
+         * or a simple textarea otherwise.
+         * 
+         * @return FCKeditor html code
          */
         public String createHtml() {