Show
Ignore:
Timestamp:
2008-07-03 00:03:15 (6 months ago)
Author:
mosipov
Message:

JavaDoc issues

Files:
1 modified

Legend:

Unmodified
Added
Removed

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

    r1699 r2151  
    4444 
    4545/** 
    46  * static error objects won't probably provided due to performance reasons of  
    47  * Document instance creation 
    48  *  
    49  * TODO document me! 
    50  * @author mosipov 
    51  * 
     46 * Creates an XML response for every <code>GET</code> request of the Connector 
     47 * servlet. This class maps directly to the XML layout descibed <a 
     48 * href="http://docs.fckeditor.net/FCKeditor_2.x/Developers_Guide/Server_Side_Integration#The_Commands">here</a>. 
     49 *  
     50 * @version $Id$ 
     51 *  
    5252 */ 
    5353public class XmlResponse { 
    … …  
    7777 
    7878        /** 
     79         * Use this contructor if want to respond a positive message. 
    7980         *  
    8081         * @param command 
    … …  
    109110         
    110111        /** 
    111          * TODO document me! 
     112         *  
     113         * Use this contructor if want to respond a negative/error message with 
     114         * custom text. 
     115         *  
    112116         * @param number 
    113117         * @param text 
    … …  
    128132        } 
    129133         
    130         /*** 
    131          * TODO document me! 
     134        /** 
     135         * Use this contructor if want to respond a negative/error message only. 
     136         *  
    132137         * @param number 
    133138         */ 
    … …  
    136141        } 
    137142 
     143        /** 
     144         * Sets an error number with a custom message. 
     145         *  
     146         * @param number 
     147         * @param text 
     148         */ 
    138149        public void setError(int number, String text) { 
    139150 
    … …  
    149160        } 
    150161 
     162        /** 
     163         * Sets an error number. 
     164         *  
     165         * @param number 
     166         */ 
    151167        public void setError(int number) { 
    152168                setError(number, null); 
    153169        } 
    154170 
     171        /** 
     172         * Lists all folders in the given dir as XML tags. 
     173         * @param dir 
     174         */ 
    155175        public void setFolders(File dir) { 
    156176 
    … …  
    171191        } 
    172192         
     193        /** 
     194         * Lists all files in the given dir as XML tags. 
     195         *  
     196         * @param dir 
     197         */ 
    173198        public void setFiles(File dir) { 
    174199                 
    … …  
    195220        } 
    196221         
     222        /** 
     223         * Lists all folders and files in the given dir as XML tags. 
     224         *  
     225         * @param dir 
     226         */      
    197227        public void setFoldersAndFiles(File dir) { 
    198228                setFolders(dir);