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/cucul.c

    r1148 r1231  
    3939/** \brief Initialise a \e libcucul canvas.
    4040 *
    41  *  This function initialises internal \e libcucul structures and the backend
    42  *  that will be used for subsequent graphical operations. It must be the
    43  *  first \e libcucul function to be called in a function. cucul_free_canvas()
     41 *  Initialise internal \e libcucul structures and the backend that will
     42 *  be used for subsequent graphical operations. It must be the first
     43 *  \e libcucul function to be called in a function. cucul_free_canvas()
    4444 *  should be called at the end of the program to free all allocated resources.
    4545 *
     
    125125/** \brief Resize a canvas.
    126126 *
    127  *  This function sets the canvas width and height, in character cells.
     127 *  Set the canvas' width and height, in character cells.
    128128 *
    129129 *  The contents of the canvas are preserved to the extent of the new
     
    164164/** \brief Get the canvas width.
    165165 *
    166  *  This function returns the current canvas width, in character cells.
     166 *  Return the current canvas' width, in character cells.
    167167 *
    168168 *  This function never fails.
     
    178178/** \brief Get the canvas height.
    179179 *
    180  *  This function returns the current canvas height, in character cells.
     180 *  Returns the current canvas' height, in character cells.
    181181 *
    182182 *  This function never fails.
     
    192192/** \brief Translate a colour index into the colour's name.
    193193 *
    194  *  This function translates a cucul_color enum into a human-readable
    195  *  description string of the associated colour.
     194 *  Translate a cucul_color enum into a human-readable string describing
     195 *  the corresponding colour.
    196196 *
    197197 *  This function never fails.
     
    231231/** \brief Uninitialise \e libcucul.
    232232 *
    233  *  This function frees all resources allocated by cucul_create_canvas(). After
    234  *  cucul_free_canvas() has been called, no other \e libcucul functions may be
     233 *  Free all resources allocated by cucul_create_canvas(). After
     234 *  this function has been called, no other \e libcucul functions may be
    235235 *  used unless a new call to cucul_create_canvas() is done.
    236236 *
     
    270270
    271271/** \brief Generate a random integer within a range.
     272 *
     273 *  Generate a random integer within the given range.
    272274 *
    273275 *  This function never fails.
Note: See TracChangeset for help on using the changeset viewer.