Ignore:
Timestamp:
Apr 14, 2006, 2:10:18 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Improved documentation in many places.
File:
1 edited

Legend:

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

    r769 r773  
    2525#include "cucul_internals.h"
    2626
    27 /**
    28  * \brief Draw a box on the screen using the given character.
     27/** \brief Draw a box on the canvas using the given character.
    2928 *
    30  * \param x1 X coordinate of the upper-left corner of the box.
    31  * \param y1 Y coordinate of the upper-left corner of the box.
    32  * \param x2 X coordinate of the lower-right corner of the box.
    33  * \param y2 Y coordinate of the lower-right corner of the box.
    34  * \param str UTF-8 string containing the character to use to draw the box.
    35  * \return void
     29 *  \param qq The handle to the libcucul canvas.
     30 *  \param x1 X coordinate of the upper-left corner of the box.
     31 *  \param y1 Y coordinate of the upper-left corner of the box.
     32 *  \param x2 X coordinate of the lower-right corner of the box.
     33 *  \param y2 Y coordinate of the lower-right corner of the box.
     34 *  \param str UTF-8 string containing the character to use to draw the box.
     35 *  \return void
    3636 */
    3737void cucul_draw_box(cucul_t *qq, int x1, int y1, int x2, int y2,
     
    4444}
    4545
    46 /**
    47  * \brief Draw a thin box on the screen.
     46/** \brief Draw a thin box on the canvas.
    4847 *
    49  * \param x1 X coordinate of the upper-left corner of the box.
    50  * \param y1 Y coordinate of the upper-left corner of the box.
    51  * \param x2 X coordinate of the lower-right corner of the box.
    52  * \param y2 Y coordinate of the lower-right corner of the box.
    53  * \return void
     48 *  \param qq The handle to the libcucul canvas.
     49 *  \param x1 X coordinate of the upper-left corner of the box.
     50 *  \param y1 Y coordinate of the upper-left corner of the box.
     51 *  \param x2 X coordinate of the lower-right corner of the box.
     52 *  \param y2 Y coordinate of the lower-right corner of the box.
     53 *  \return void
    5454 */
    5555void cucul_draw_thin_box(cucul_t *qq, int x1, int y1, int x2, int y2)
     
    106106}
    107107
    108 /**
    109  * \brief Fill a box on the screen using the given character.
     108/** \brief Fill a box on the canvas using the given character.
    110109 *
    111  * \param x1 X coordinate of the upper-left corner of the box.
    112  * \param y1 Y coordinate of the upper-left corner of the box.
    113  * \param x2 X coordinate of the lower-right corner of the box.
    114  * \param y2 Y coordinate of the lower-right corner of the box.
    115  * \param str UTF-8 string containing the character to fill the box with.
    116  * \return void
     110 *  \param qq The handle to the libcucul canvas.
     111 *  \param x1 X coordinate of the upper-left corner of the box.
     112 *  \param y1 Y coordinate of the upper-left corner of the box.
     113 *  \param x2 X coordinate of the lower-right corner of the box.
     114 *  \param y2 Y coordinate of the lower-right corner of the box.
     115 *  \param str UTF-8 string containing the character to fill the box with.
     116 *  \return void
    117117 */
    118118void cucul_fill_box(cucul_t *qq, int x1, int y1, int x2, int y2,
Note: See TracChangeset for help on using the changeset viewer.