Show
Ignore:
Timestamp:
2008-06-23 00:00:48 (7 months ago)
Author:
mosipov
Message:

NEW - #1968: Javadoc issues

Files:
1 modified

Legend:

Unmodified
Added
Removed

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

    r1905 r2101  
    2525 
    2626/** 
    27  * Handler for the get and post commands. 
     27 * Handler for <code>GET</code> and <code>POST</code> commands. 
    2828 *  
    2929 * @version $Id$ 
    … …  
    6060         * Getter for the name. 
    6161         *  
    62          * @return name 
     62         * @return The command name 
    6363         */ 
    6464        public String getName() { 
    … …  
    7070         *  
    7171         * @param name 
    72          * @return A {@link CommandHandler} object holding the value represented by the string 
    73          *         argument. 
     72         *            A command to retrieve 
     73         * @return A {@link CommandHandler} object holding the value represented by 
     74         *         the string argument. 
    7475         * @throws IllegalArgumentException 
    75          *             If 'name' is null or can't be parsed. 
     76         *             If 'name' is <code>null</code> or does not exist. 
    7677         */ 
    7778        public static CommandHandler valueOf(final String name) throws IllegalArgumentException { 
    … …  
    8687 
    8788        /** 
    88          * Checks, if a specfied string is a valid representation of a get command. 
     89         * Checks if a specfied string represents a valid <code>GET</code> 
     90         * command. 
    8991         *  
    9092         * @param name 
    91          * @return True, if the string representation is valid, or false. 
     93         *            A command string to check 
     94         * @return <code>true</code> if the string representation is valid else 
     95         *         <code>false</code>. 
    9296         */ 
    9397        public static boolean isValidForGet(final String name) { 
    … …  
    96100 
    97101        /** 
    98          * Checks, if a specfied string is a valid representation of a post command. 
     102         * Checks if a specfied string represents a valid <code>POST</code> 
     103         * command. 
    99104         *  
    100105         * @param name 
    101          * @return True, if the string representation is valid, or false. 
     106         *            A command string to check 
     107         * @return <code>true</code> if the string representation is valid else 
     108         *         <code>false</code>. 
    102109         */ 
    103110        public static boolean isValidForPost(final String name) { 
    … …  
    107114         
    108115        /** 
    109          * A wrapper for {@link #valueOf(String)}. It returns null instead of throwing an exception. 
     116         * A wrapper for {@link #valueOf(String)}. It returns null instead of 
     117         * throwing an exception. 
    110118         *  
    111          * @param name 
    112          * @return A {@link CommandHandler} object holding the value represented by the string 
    113          *         argument, or null. 
     119         * @param name A command string to check 
     120         * @return A {@link CommandHandler} object holding the value represented by 
     121         *         the string argument, or <code>null</code>. 
    114122         */ 
    115123        public static CommandHandler getCommand(final String name) { 
    … …  
    128136        @Override 
    129137        public boolean equals(Object obj) { 
     138                if (obj == null) 
     139                        return false; 
    130140                try { 
    131141                        CommandHandler rt = (CommandHandler) obj;