Ignore:
Timestamp:
Oct 26, 2006, 12:06:21 AM (14 years ago)
Author:
Sam Hocevar
Message:
  • Removed "This function..." constructs from documentation. Fixed a few documentation errors or imprecisions.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/cucul/charset.c

    r1211 r1231  
    9595/** \brief Convert a UTF-8 character to UTF-32.
    9696 *
    97  *  This function converts a UTF-8 character read from a string and returns
    98  *  its value in the UTF-32 character set. If the second argument is not null,
    99  *  the total number of read bytes is written in it.
     97 *  Convert a UTF-8 character read from a string and return its value in
     98 *  the UTF-32 character set. If the second argument is not null, the total
     99 *  number of read bytes is written in it.
    100100 *
    101101 *  If a null byte was reached before the expected end of the UTF-8 sequence,
     
    139139/** \brief Convert a UTF-32 character to UTF-8.
    140140 *
    141  *  This function converts a UTF-32 character read from a string and writes
    142  *  its value in the UTF-8 character set into the given buffer.
     141 *  Convert a UTF-32 character read from a string and write its value in
     142 *  the UTF-8 character set into the given buffer.
    143143 *
    144144 *  This function never fails, but its behaviour with illegal UTF-32 characters
     
    182182/** \brief Convert a UTF-32 character to CP437.
    183183 *
    184  *  This function converts a UTF-32 character read from a string and returns
    185  *  its value in the CP437 character set, or "?" if the character has no
    186  *  equivalent.
     184 *  Convert a UTF-32 character read from a string and return its value in
     185 *  the CP437 character set, or "?" if the character has no equivalent.
    187186 *
    188187 *  This function never fails.
     
    214213/** \brief Convert a CP437 character to UTF-32.
    215214 *
    216  *  This function converts a CP437 character read from a string and returns
    217  *  its value in the UTF-32 character set, or zero if the character is a
    218  *  CP437 control character.
     215 *  Convert a CP437 character read from a string and return its value in
     216 *  the UTF-32 character set, or zero if the character is a CP437 control
     217 *  character.
    219218 *
    220219 *  This function never fails.
     
    239238/** \brief Tell whether a UTF-32 character is fullwidth.
    240239 *
    241  *  This function returns 1 if the given UTF-32 character should be
    242  *  printed at twice the normal width (fullwidth), or 0 if it is a
    243  *  standard-width character or if the library does not know.
     240 *  Check whether the given UTF-32 character should be printed at twice
     241 *  the normal width (fullwidth characters). If the character is unknown
     242 *  or if its status cannot be decided, it is treated as a standard-width
     243 *  character.
    244244 *
    245245 *  This function never fails.
Note: See TracChangeset for help on using the changeset viewer.