Changeset 2146

Show
Ignore:
Timestamp:
2008-07-02 14:13:03 (6 months ago)
Author:
th-schwarz
Message:

javadoc issues

Location:
FCKeditor.Java/trunk/java-core/src/main/java/net/fckeditor
Files:
3 modified

Legend:

Unmodified
Added
Removed

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

    r2101 r2146  
    167167 
    168168        /** 
    169          * Get the advanced configuation set.<br /> 
     169         * Get the advanced configuration set.<br /> 
    170170         * By adding elements to this collection you can override the settings 
    171171         * specified in the config.js file. 
    … …  
    178178 
    179179        /** 
    180          * Set the advanced configuation set. 
     180         * Set the advanced configuration set. 
    181181         *  
    182182         * @param value 
    … …  
    198198                if (Utils.isEmpty(txt)) 
    199199                        return txt; 
    200                 // TODO Strings are inefficent, use StringBuffer instead 
    201200                txt = txt.replaceAll("&", "&#38;"); 
    202201                txt = txt.replaceAll("<", "&#60;"); 
    … …  
    244243                        String configStr = config.getUrlParams(); 
    245244                        if (Utils.isNotEmpty(configStr)) 
    246                                 // configStr = configStr.substring(1); 
    247245                                strEditor.append(createInputForVariable(null, instanceName.concat("___Config"), 
    248246                                        configStr)); 

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

    r2101 r2146  
    8181 
    8282        /** 
    83          * Checks if the underlying file of the InputStrem is an image. 
     83         * Checks if the underlying file of the InputStream is an image. 
    8484         *  
    8585         * @param in An input stream 
    … …  
    9494 
    9595        /** 
    96      * TODO - document me! 
     96     * Checks, if <code>path</code> is a valid one.  
    9797     *  
    9898     * @param path 
    … …  
    116116 
    117117        /** 
    118      * TODO - document me! 
     118     * Makes sure that <code>filename</code> has only one extension. 
     119     * Other dots will be replaced with '_'. 
    119120     *  
    120121     * @param filename 
    121      * @return string with a single dot only 
     122     * @return String with a single extension only. 
    122123     */ 
    123124    public static String forceSingleExtension(final String filename) { 
    … …  
    126127 
    127128        /** 
    128      * TODO - document me! 
     129     * Checks, if <code>filename</code> has a single extension. 
    129130     *  
    130131     * @param filename 
    131      * @return <code>true</code> if filename contains severals dots else 
    132      *         <code>false</code> 
     132     * @return <code>true</code> if filename has just one dot, else 
     133     *         <code>false</code>. 
    133134     */ 
    134135    public static boolean isSingleExtension(final String filename) { 
    … …  
    137138     
    138139    /** 
    139          * TODO - document me! 
    140          * @param dir 
     140         * Checks if <code>dir</code> exists, if not it will be created. 
     141         *  
     142         * @param dir Directory to check/create. 
    141143         */ 
    142         public static void checkDirAndCreate(File dir) { 
     144        public static void checkDirAndCreate(final File dir) { 
    143145                if (!dir.exists()) { 
    144146                        dir.mkdirs(); 
    … …  
    148150         
    149151        /** 
    150          * TODO - document me! 
     152         * Constructs the server-side path for a special <code>resourceType</code>.  
     153         * Path is inside the <code>UserFilePath</code>. 
     154         *  
    151155         * @param request 
    152156         * @param resourceType 
    153          * @return server-side path 
     157         * @return server-side path of <code>resourceType</code>. 
    154158         */ 
    155         public static String constructServerSidePath(HttpServletRequest request, 
    156                         ResourceTypeHandler resourceType) { 
     159        public static String constructServerSidePath(final HttpServletRequest request, 
     160                        final ResourceTypeHandler resourceType) { 
    157161                StringBuffer sb = new StringBuffer(ConnectorHandler 
    158162                                .getUserFilesPath(request)); 

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

    r2028 r2146  
    2323import javax.servlet.http.HttpServletRequest; 
    2424 
     25import net.fckeditor.connector.ConnectorServlet; 
    2526import net.fckeditor.handlers.ConnectorHandler; 
    2627import net.fckeditor.handlers.ResourceTypeHandler; 
    … …  
    3435 
    3536        /** 
    36          * TODO - document me! 
     37         * Constructs an url, using as response in {@link ConnectorServlet}. 
    3738     *  
    3839     * @param request