Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Aug 31, 2010, 8:37:29 PM (14 years ago)
Author:
landauf
Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

Location:
code/branches/doc/src/libraries/util
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • code/branches/doc/src/libraries/util/Convert.h

    r7284 r7297  
    278278        For information about the different conversion methods (user defined too), see the section
    279279        'Actual conversion sequence' in this file above.
     280    @param output
     281        A pointer to the variable where the converted value will be stored
     282    @param input
     283        The original value
    280284    */
    281285    template <class FromType, class ToType>
    … …  
    294298        'Actual conversion sequence' in this file above.
    295299        If the conversion doesn't succeed, 'fallback' is written to '*output'.
     300    @param output
     301        A pointer to the variable where the converted value will be stored
     302    @param input
     303        The original value
    296304    @param fallback
    297305        A default value that gets written to '*output' if there is no conversion.

  • code/branches/doc/src/libraries/util/Exception.h

    r6417 r7297  
    6060        @param description
    6161            Exception description as string. This message is supposed to help developers!
     62        @param lineNumber
     63            The number of the code-line in which the exception occurred
     64        @param filename
     65            The file in which the exception occurred
     66        @param functionName
     67            The function in which the exception occurred
    6268        */
    6369        Exception(const std::string& description, unsigned int lineNumber,

  • code/branches/doc/src/libraries/util/OutputHandler.cc

    r6417 r7297  
    6767        @brief
    6868            Gets temporary log path and starts the log file
    69         @param outputHandler
    70             This is only required to avoid another call to getInstance (this c'tor was
    71             called from getInstance!)
    7269        */
    7370        LogFileWriter()
    … …  
    162159        @brief
    163160            Sets the right soft debug level and registers itself
    164         @param outputHandler
    165             This is only required to avoid another call to getInstance (this c'tor was
    166             called from getInstance!)
    167161        */
    168162        MemoryLogWriter()

  • code/branches/doc/src/libraries/util/StringUtils.cc

    r7284 r7297  
    142142    /**
    143143        @brief Returns true if the string contains something like '..."between quotes"...'.
    144         @param The string
     144        @param str The string
    145145        @return True if there is something between quotes
    146146    */
    … …  
    154154    /**
    155155        @brief If the string contains something like '..."between quotes"...' then 'between quotes' gets returned (without quotes).
    156         @param The string
    157         @param The string between the quotes
     156        @param str The string between the quotes
    158157    */
    159158    std::string getStringBetweenQuotes(const std::string& str)
    … …  
    169168    /**
    170169        @brief Removes enclosing quotes if available (including whitespaces at the outside of the quotes).
    171         @brief str The string to strip
     170        @param str The string to strip
    172171        @return The string with removed quotes
    173172    */

  • code/branches/doc/src/libraries/util/SubString.cc

    r7284 r7297  
    6262
    6363    /**
    64      * @brief Splits a String into multiple splitters.
    65      * @param string the String to split
    66      * @param delimiters multiple set of characters at what to split. (delimiters)
    67      * @param delimiterNeighbours neighbours of the delimiters, that will be erased only when near a delimiter.
    68      * @param emptyEntries If empty entries should be allewed or removed.
    69      * @param escapeChar The Escape Character that overrides splitters commends and so on...
    70      * @param safemode_char within these characters splitting won't happen
    71      * @param comment_char the Comment character.
     64     * @brief Splits a string into multiple tokens.
     65     * @param string The string to split
     66     * @param delimiters Multiple set of characters at what to split. (delimiters)
     67     * @param delimiterNeighbours Neighbours of the delimiters that will be erased as well.
     68     * @param emptyEntries If empty entries are added to the list of SubStrings
     69     * @param escapeChar The escape character that overrides splitters commends and so on...
     70     * @param removeEscapeChar If true, the escape char is removed from the tokens
     71     * @param safemode_char Within these characters splitting won't happen
     72     * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
     73     * @param openparenthesis_char The beginning of a safemode is marked with this
     74     * @param closeparenthesis_char The ending of a safemode is marked with this
     75     * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
     76     * @param comment_char The comment character.
    7277     */
    7378    SubString::SubString(const std::string& string,
    … …  
    234239
    235240    /**
    236      * @brief Splits a String into multiple splitters.
    237      * @param string the String to split
    238      * @param delimiters multiple set of characters at what to split. (delimiters)
    239      * @param delimiterNeighbours: Neighbours to the Delimiters that will be erased too.
    240      * @param emptyEntries: If empty entries are added to the List of SubStrings
    241      * @param escapeChar The Escape Character that overrides splitters commends and so on...
    242      * @param safemode_char within these characters splitting won't happen
    243      * @param comment_char the Comment character.
     241     * @brief Splits a string into multiple tokens.
     242     * @param string The string to split
     243     * @param delimiters Multiple set of characters at what to split. (delimiters)
     244     * @param delimiterNeighbours: Neighbours of the delimiters that will be erased too.
     245     * @param emptyEntries: If empty entries are added to the list of SubStrings
     246     * @param escapeChar The escape character that overrides splitters commends and so on...
     247     * @param removeEscapeChar If true, the escape char is removed from the tokens
     248     * @param safemode_char Within these characters splitting won't happen
     249     * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
     250     * @param openparenthesis_char The beginning of a safemode is marked with this
     251     * @param closeparenthesis_char The ending of a safemode is marked with this
     252     * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
     253     * @param comment_char The comment character.
    244254     */
    245255    unsigned int SubString::split(const std::string& string,
    246256                                  const std::string& delimiters, const std::string& delimiterNeighbours, bool emptyEntries,
    247                                   char escapeChar, bool removeExcapeChar, char safemode_char, bool removeSafemodeChar,
     257                                  char escapeChar, bool removeEscapeChar, char safemode_char, bool removeSafemodeChar,
    248258                                  char openparenthesis_char, char closeparenthesis_char, bool removeParenthesisChars, char comment_char)
    249259    {
    250260        this->strings.clear();
    251261        this->bInSafemode.clear();
    252         SubString::splitLine(this->strings, this->bInSafemode, string, delimiters, delimiterNeighbours, emptyEntries, escapeChar, removeExcapeChar, safemode_char, removeSafemodeChar, openparenthesis_char, closeparenthesis_char, removeParenthesisChars, comment_char);
     262        SubString::splitLine(this->strings, this->bInSafemode, string, delimiters, delimiterNeighbours, emptyEntries, escapeChar, removeEscapeChar, safemode_char, removeSafemodeChar, openparenthesis_char, closeparenthesis_char, removeParenthesisChars, comment_char);
    253263        return this->strings.size();
    254264    }
    … …  
    304314
    305315    /**
    306      * @brief splits line into tokens and stores them in ret.
    307      * @param ret the Array, where the Splitted strings will be stored in
    308      * to the beginning of the current token is stored
    309      * @param line the inputLine to split
    310      * @param delimiters a String of Delimiters (here the input will be splitted)
    311      * @param delimiterNeighbours Neighbours to the Delimiter, that will be removed if they are to the left or the right of a Delimiter.
    312      * @param emptyEntries: if empty Strings are added to the List of Strings.
    313      * @param escape_char: Escape carater (escapes splitters)
    314      * @param safemode_char: the beginning of the safemode is marked with this
    315      * @param removeSafemodeChar removes the safemode_char from the beginning and the ending of a token
    316      * @param openparenthesis_char the beginning of a safemode is marked with this
    317      * @param closeparenthesis_char the ending of a safemode is marked with this
    318      * @param removeParenthesisChars removes the parenthesis from the beginning and the ending of a token
    319      * @param comment_char: the beginning of a comment is marked with this: (until the end of a Line)
    320      * @param start_state: the Initial state on how to parse the String.
     316     * @brief Splits a line into tokens and stores them in ret.
     317     * @param ret The array, where the splitted strings will be stored in
     318     * @param bInSafemode A vector wich stores for each character of the string if it is in safemode or not
     319     * @param line The inputLine to split
     320     * @param delimiters A string of delimiters (here the input will be splitted)
     321     * @param delimiterNeighbours Neighbours of the delimiter, that will be removed if they are to the left or the right of a delimiter.
     322     * @param emptyEntries If empty strings are added to the list of strings.
     323     * @param escape_char Escape carater (escapes splitters)
     324     * @param removeEscapeChar If true, the escape char is removed from the tokens
     325     * @param safemode_char The beginning of the safemode is marked with this
     326     * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
     327     * @param openparenthesis_char The beginning of a safemode is marked with this
     328     * @param closeparenthesis_char The ending of a safemode is marked with this
     329     * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
     330     * @param comment_char The beginning of a comment is marked with this: (until the end of a line)
     331     * @param start_state The initial state on how to parse the string.
    321332     * @return SPLIT_LINE_STATE the parser was in when returning
    322333     *
    … …  
    333344                         bool emptyEntries,
    334345                         char escape_char,
    335                          bool removeExcapeChar,
     346                         bool removeEscapeChar,
    336347                         char safemode_char,
    337348                         bool removeSafemodeChar,
    … …  
    368379                {
    369380                    state = SL_ESCAPE;
    370                     if (!removeExcapeChar)
     381                    if (!removeEscapeChar)
    371382                        token += line[i];
    372383                }

  • code/branches/doc/src/libraries/util/SubString.h

    r7291 r7297  
    115115        unsigned int split(const std::string& string,
    116116                           const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries = false,
    117                            char escapeChar ='\\', bool removeExcapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
     117                           char escapeChar ='\\', bool removeEscapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
    118118                           char openparenthesis_char = '{', char closeparenthesis_char = '}',  bool removeParenthesisChars = true, char comment_char = '\0');
    119119        std::string join(const std::string& delimiter = " ") const;
    … …  
    152152                                          bool emptyEntries = false,
    153153                                          char escape_char = '\\',
    154                                           bool removeExcapeChar = true,
     154                                          bool removeEscapeChar = true,
    155155                                          char safemode_char = '"',
    156156                                          bool removeSafemodeChar = true,
Note: See TracChangeset for help on using the changeset viewer.