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.
Location:
libcaca/trunk/caca
Files:
2 edited

Legend:

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

    r1006 r1231  
    4343/** \brief Get the next mouse or keyboard input event.
    4444 *
    45  *  This function polls the event queue for mouse or keyboard events matching
    46  *  the event mask and returns the first matching event. Non-matching events
    47  *  are discarded. If \c event_mask is zero, the function returns immediately.
     45 *  Poll the event queue for mouse or keyboard events matching the event
     46 *  mask and return the first matching event. Non-matching events are
     47 *  discarded. If \c event_mask is zero, the function returns immediately.
    4848 *
    4949 *  The timeout value tells how long this function needs to wait for an
     
    115115/** \brief Return the X mouse coordinate.
    116116 *
    117  *  This function returns the X coordinate of the mouse position last time
     117 *  Return the X coordinate of the mouse position last time
    118118 *  it was detected. This function is not reliable if the ncurses or S-Lang
    119119 *  drivers are being used, because mouse position is only detected when
     
    135135/** \brief Return the Y mouse coordinate.
    136136 *
    137  *  This function returns the Y coordinate of the mouse position last time
     137 *  Return the Y coordinate of the mouse position last time
    138138 *  it was detected. This function is not reliable if the ncurses or S-Lang
    139139 *  drivers are being used, because mouse position is only detected when
  • libcaca/trunk/caca/graphics.c

    r1006 r1231  
    9090/** \brief Set the refresh delay.
    9191 *
    92  *  This function sets the refresh delay in microseconds. The refresh delay
    93  *  is used by caca_refresh_display() to achieve constant framerate. See the
     92 *  Set the refresh delay in microseconds. The refresh delay is used by
     93 *  caca_refresh_display() to achieve constant framerate. See the
    9494 *  caca_refresh_display() documentation for more details.
    9595 *
     
    111111/** \brief Get the display's average rendering time.
    112112 *
    113  *  This function returns the average rendering time, which is the average
    114  *  measured time between two caca_refresh_display() calls, in microseconds. If
    115  *  constant framerate was activated by calling caca_set_display_time(), the
    116  *  average rendering time will not be considerably shorter than the requested
    117  *  delay even if the real rendering time was shorter.
     113 *  Get the average rendering time, which is the average measured time
     114 *  between two caca_refresh_display() calls, in microseconds. If constant
     115 *  framerate was activated by calling caca_set_display_time(), the average
     116 *  rendering time will be close to the requested delay even if the real
     117 *  rendering time was shorter.
    118118 *
    119119 *  This function never fails.
     
    129129/** \brief Flush pending changes and redraw the screen.
    130130 *
    131  *  This function flushes all graphical operations and prints them to the
    132  *  screen. Nothing will show on the screen until caca_refresh_display() is
    133  *  called.
     131 *  Flush all graphical operations and print them to the display device.
     132 *  Nothing will show on the screen until this function is called.
    134133 *
    135134 *  If caca_set_display_time() was called with a non-zero value,
     
    183182/** \brief Show or hide the mouse pointer.
    184183 *
    185  *  This function shows or hides the mouse pointer, for devices that
    186  *  support it.
     184 *  Show or hide the mouse pointer, for devices that support such a feature.
    187185 *
    188186 *  If an error occurs, -1 is returned and \b errno is set accordingly:
Note: See TracChangeset for help on using the changeset viewer.