Ignore:
Timestamp:
Apr 14, 2006, 2:10:18 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Improved documentation in many places.
Location:
libcaca/trunk/caca
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/caca/caca.c

    r769 r773  
    9999 *  attached to it afterwards.
    100100 *
    101  *  \param qq The caca graphical context.
     101 *  \param kk The libcaca graphical context.
    102102 */
    103103void caca_detach(caca_t *kk)
  • libcaca/trunk/caca/caca.h

    r769 r773  
    7878#define __CACA_H__
    7979
     80/** libcaca API version */
    8081#define CACA_API_VERSION_1
    8182
  • libcaca/trunk/caca/event.c

    r769 r773  
    5151 *  function to wait indefinitely until a matching event is received.
    5252 *
    53  * \param event_mask Bitmask of requested events.
    54  * \param timeout A timeout value in microseconds
    55  * \return The next matching event in the queue, or 0 if no event is pending.
     53 *  \param kk The libcaca graphical context.
     54 *  \param event_mask Bitmask of requested events.
     55 *  \param timeout A timeout value in microseconds
     56 *  \param ev A pointer to a caca_event structure.
     57 *  \return The next matching event in the queue, or 0 if no event is pending.
    5658 */
    5759int caca_get_event(caca_t *kk, unsigned int event_mask,
     
    107109 *  the mouse is clicked. Other drivers such as X11 work well.
    108110 *
     111 *  \param kk The libcaca graphical context.
    109112 *  \return The X mouse coordinate.
    110113 */
     
    124127 *  the mouse is clicked. Other drivers such as X11 work well.
    125128 *
     129 *  \param kk The libcaca graphical context.
    126130 *  \return The Y mouse coordinate.
    127131 */
  • libcaca/trunk/caca/graphics.c

    r769 r773  
    2828 *  the X11 and Win32 drivers.
    2929 *
     30 *  \param kk The libcaca graphical context.
    3031 *  \param title The desired window title.
    3132 *  \return 0 upon success, a non-zero value if an error occurs.
     
    4344 *  6x10 font is being used. Note that the units are not necessarily pixels.
    4445 *
     46 *  \param kk The libcaca graphical context.
    4547 *  \return The window width.
    4648 */
     
    5759 *  used. Note that the units are not necessarily pixels.
    5860 *
     61 *  \param kk The libcaca graphical context.
    5962 *  \return The window height.
    6063 */
     
    7376 *  default behaviour.
    7477 *
     78 *  \param kk The libcaca graphical context.
    7579 *  \param usec The refresh delay in microseconds.
    7680 */
     
    8892 *  even if the real rendering time was shorter.
    8993 *
     94 *  \param kk The libcaca graphical context.
    9095 *  \return The render time in microseconds.
    9196 */
     
    106111 *  set with caca_set_delay(), the second call will wait a bit before
    107112 *  performing the screen refresh.
     113 *
     114 *  \param kk The libcaca graphical context.
    108115 */
    109116void caca_display(caca_t *kk)
     
    147154 *  support it.
    148155 *
     156 *  \param kk The libcaca graphical context.
    149157 *  \param flag 0 hides the pointer, 1 shows the system's default pointer
    150158 *              (usually an arrow). Other values are reserved for future use.
Note: See TracChangeset for help on using the changeset viewer.