Changeset 2101 for FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor/connector/ConnectorServlet.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/connector/ConnectorServlet.java (modified) (5 diffs)

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

@@ -51 +51 @@
 
 /**
- * Servlet to upload and browse files.<br>
- * 
- * This servlet accepts 4 commands used to retrieve and create files and folders from a server
- * directory. The allowed commands are:
+ * Servlet to upload and browse files.<br />
+ * 
+ * This servlet accepts 4 commands which interact with the server-side
+ * filesystem.<br />
+ * The allowed commands are:
  * <ul>
- * <li>GetFolders: Retrieve the list of directory under the current folder
- * <li>GetFoldersAndFiles: Retrive the list of files and directory under the current folder
- * <li>CreateFolder: Create a new directory under the current folder
- * <li>FileUpload: Send a new file to the server (must be sent with a POST)
+ * <li><code>GetFolders</code>: Retrieves a list of folders in the current
+ * folder</li>
+ * <li><code>GetFoldersAndFiles</code>: Retrives a list of files and folders
+ * in the current folder</li>
+ * <li><code>CreateFolder</code>: Creates a new folder in the current folder</li>
+ * <li><code>FileUpload</code>: Stores an uploaded file into the current
+ * folder. (must be sent with POST)</li>
  * </ul>
  * 
@@ -70 +74 @@
 
         /**
-         * Initialize the servlet.<br>
-         * The default directory for user files will be constructed.
+         * Initialize the servlet: <code>mkdir</code> &lt;DefaultUserFilesPath&gt;
          */
         public void init() throws ServletException, IllegalArgumentException {
-                // check, if 'baseDir' exists
                 String realDefaultUserFilesPath = getServletContext().getRealPath(
                         ConnectorHandler.getDefaultUserFilesPath());
@@ -81 +83 @@
                 UtilsFile.checkDirAndCreate(defaultUserFilesDir);
 
-                logger.info("ConnectorServlet successful initialized!");
+                logger.info("ConnectorServlet successfully initialized!");
         }
 
         /**
-         * Manage the Get requests (GetFolders, GetFoldersAndFiles, CreateFolder).<br>
+         * Manage the <code>GET</code> requests (<code>GetFolders</code>,
+         * <code>GetFoldersAndFiles</code>, <code>CreateFolder</code>).<br/>
          * 
-         * The servlet accepts commands sent in the following format:<br>
-         * connector?Command=CommandName&Type=ResourceType&CurrentFolder=FolderPath<br>
-         * <br>
-         * It executes the commands and then return the results to the client in XML format.
-         * 
+         * The servlet accepts commands sent in the following format:<br/>
+         * <code>connector?Command=&lt;CommandName&gt;&Type=&lt;ResourceType&gt;&CurrentFolder=&lt;FolderPath&gt;</code>
+         * <p>
+         * It executes the commands and then returns the result to the client in XML
+         * format.
+         * </p>
          */
         public void doGet(HttpServletRequest request, HttpServletResponse response)
@@ -174 +178 @@
 
         /**
-         * Manage the Post requests (FileUpload).<br>
+         * Manage the <code>POST</code> requests (<code>FileUpload</code>).<br />
          * 
-         * The servlet accepts commands sent in the following format:<br>
-         * connector?Command=FileUpload&Type=ResourceType&CurrentFolder=FolderPath<br>
+         * The servlet accepts commands sent in the following format:<br />
+         * <code>connector?Command=&lt;FileUpload&gt;&Type=&lt;ResourceType&gt;&CurrentFolder=&lt;FolderPath&gt;</code>
+         * with the file in the <code>POST</code> body.<br />
          * <br>
-         * It store the file (renaming it in case a file with the same name exists) and then return an
-         * HTML file with a javascript command in it.
+         * It stores an uploaded file (renames a file if another exists with the
+         * same name) and then returns the JavaScript callback.
          */
         @SuppressWarnings("unchecked")
@@ -202 +207 @@
                 UploadResponse ur;
 
-                // if this is a QuickUpload-Request, 'commandStr' and 'currentFolderStr' are empty
+                // if this is a QuickUpload request, 'commandStr' and 'currentFolderStr'
+                // are empty
                 if (Utils.isEmpty(commandStr) && Utils.isEmpty(currentFolderStr)) {
                         commandStr = "QuickUpload";