Ignore:
Timestamp:
Oct 26, 2006, 12:06:21 AM (13 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/canvas.c

    r1224 r1231  
    4444/** \brief Print an ASCII or Unicode character.
    4545 *
    46  *  This function prints an ASCII or Unicode character at the given
    47  *  coordinates, using the default foreground and background values.
     46 *  Print an ASCII or Unicode character at the given coordinates, using
     47 *  the default foreground and background colour values.
    4848 *
    4949 *  If the coordinates are outside the canvas boundaries, nothing is printed.
    50  *  If a fullwidth Unicode character gets overwritten, its remaining parts
    51  *  are replaced with spaces. If the canvas' boundaries would split the
     50 *  If a fullwidth Unicode character gets overwritten, its remaining visible
     51 *  parts are replaced with spaces. If the canvas' boundaries would split the
    5252 *  fullwidth character in two, a space is printed instead.
    5353 *
     
    126126/** \brief Get the Unicode character at the given coordinates.
    127127 *
    128  *  This function gets the ASCII or Unicode value of the character at
    129  *  the given coordinates. If the value is less or equal to 127 (0x7f),
     128 *  Get the ASCII or Unicode value of the character at the given
     129 *  coordinates. If the value is less or equal to 127 (0x7f),
    130130 *  the character can be printed as ASCII. Otherise, it must be handled
    131131 *  as a UTF-32 value.
     
    145145 *  \param y Y coordinate.
    146146 *  \param ch The requested character value.
    147  *  \return The character always returns 0.
     147 *  \return This function always returns 0.
    148148 */
    149149unsigned long int cucul_getchar(cucul_canvas_t *cv, int x, int y)
     
    157157/** \brief Print a string.
    158158 *
    159  *  This function prints an UTF-8 string at the given coordinates, using the
    160  *  default foreground and background values. The coordinates may be outside
    161  *  the canvas boundaries (eg. a negative Y coordinate) and the string will
     159 *  Print an UTF-8 string at the given coordinates, using the default
     160 *  foreground and background values. The coordinates may be outside the
     161 *  canvas boundaries (eg. a negative Y coordinate) and the string will
    162162 *  be cropped accordingly if it is too long.
    163163 *
     
    199199/** \brief Print a formated string.
    200200 *
    201  *  This function formats a string at the given coordinates, using the
    202  *  default foreground and background values. The coordinates may be outside
    203  *  the canvas boundaries (eg. a negative Y coordinate) and the string will
    204  *  be cropped accordingly if it is too long. The syntax of the format
    205  *  string is the same as for the C printf() function.
     201 *  Format a string at the given coordinates, using the default foreground
     202 *  and background values. The coordinates may be outside the canvas
     203 *  boundaries (eg. a negative Y coordinate) and the string will be cropped
     204 *  accordingly if it is too long. The syntax of the format string is the
     205 *  same as for the C printf() function.
    206206 *
    207207 *  This function never fails.
     
    245245/** \brief Clear the canvas.
    246246 *
    247  *  This function clears the canvas using the current background colour.
     247 *  Clear the canvas using the current foreground and background colours.
    248248 *
    249249 *  This function never fails.
     
    268268/** \brief Blit a canvas onto another one.
    269269 *
    270  *  This function blits a canvas onto another one at the given coordinates.
     270 *  Blit a canvas onto another one at the given coordinates.
    271271 *  An optional mask canvas can be used.
    272272 *
     
    349349/** \brief Set a canvas' new boundaries.
    350350 *
    351  *  This function sets new boundaries for a canvas. It can be used to crop a
     351 *  Set new boundaries for a canvas. This function can be used to crop a
    352352 *  canvas, to expand it or for combinations of both actions.
    353353 *
Note: See TracChangeset for help on using the changeset viewer.