Changeset 26554

Show
Ignore:
Timestamp:
2007-03-06 01:30:30 (4 years ago)
Author:
res2002
Message:

Small csUnicodeTransform doxygen tweaks

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • CS/trunk/include/csutil/csuctransform.h

    r23667 r26554  
    110110   * \param strlen Number of code units in the source string. 
    111111   * \param ch Decoded code point. 
    112    * \param isValid When an error occured during decoding, \p ch contains the 
     112   * \param isValid When an error occured during decoding, \a ch contains the 
    113113   *  replacement character (#CS_UC_CHAR_REPLACER). In this case, the bool 
    114    *  pointed to by \p isValid will be set to false. The parameter can be 0, 
     114   *  pointed to by \a isValid will be set to false. The parameter can be 0, 
    115115   *  but in this case the information whether the decoded char is the  
    116116   *  replacement character because the source data is errorneous is lost. 
    … …  
    324324   *  are encoded. Normally, those code points are rejected to prevent the 
    325325   *  generation of invalid encoded strings. 
    326    * \return The number of code units needed to encode \p ch. 
     326   * \return The number of code units needed to encode \a ch. 
    327327   * \remark The buffer will be filled up as much as possible. 
    328328   *  Check the returned value whether the encoded code point completely fit  
    … …  
    853853   * \param maxSkip The number of code units to skip at max. Usually, this is 
    854854   *  the number of chars from \a str to the end of the buffer. 
    855    * \return Number of chars to skip in the buffer. Returns 0 if \p maxSkip is 
     855   * \return Number of chars to skip in the buffer. Returns 0 if \a maxSkip is 
    856856   *  0. 
    857857   */ 
    … …  
    895895   *  is the number of chars from \a str to the start of the buffer. 
    896896   * \return Number of chars to skip back in the buffer. Returns 0 if  
    897    *  \p maxRew is 0. 
     897   *  \a maxRew is 0. 
    898898   */ 
    899899  inline static int UTF8Rewind (const utf8_char* str, size_t maxRew) 
    … …  
    986986   * \param destSize Number of code units the destination buffer can hold. 
    987987   * \param flags Flags to control the result of the mapping. Currently  
    988    *   supported is csUcMapSimple. 
     988   *   supported is #csUcMapSimple. 
    989989   * \return Number of code units the complete mapping result would require. 
    990990   */