Changeset 773 for libcaca/trunk/caca/graphics.cTweet

Timestamp:

Apr 14, 2006, 2:10:18 PM (15 years ago)

Author:

Sam Hocevar

Message:

• Improved documentation in many places.

File:

• libcaca/trunk/caca/graphics.c (modified) (7 diffs)

libcaca/trunk/caca/graphics.c

@@ -28 +28 @@
  *  the X11 and Win32 drivers.
  *
+ *  \param kk The libcaca graphical context.
  *  \param title The desired window title.
  *  \return 0 upon success, a non-zero value if an error occurs.
@@ -43 +44 @@
  *  6x10 font is being used. Note that the units are not necessarily pixels.
  *
+ *  \param kk The libcaca graphical context.
  *  \return The window width.
  */
@@ -57 +59 @@
  *  used. Note that the units are not necessarily pixels.
  *
+ *  \param kk The libcaca graphical context.
  *  \return The window height.
  */
@@ -73 +76 @@
  *  default behaviour.
  *
+ *  \param kk The libcaca graphical context.
  *  \param usec The refresh delay in microseconds.
  */
@@ -88 +92 @@
  *  even if the real rendering time was shorter.
  *
+ *  \param kk The libcaca graphical context.
  *  \return The render time in microseconds.
  */
@@ -106 +111 @@
  *  set with caca_set_delay(), the second call will wait a bit before
  *  performing the screen refresh.
+ *
+ *  \param kk The libcaca graphical context.
  */
 void caca_display(caca_t *kk)
@@ -147 +154 @@
  *  support it.
  *
+ *  \param kk The libcaca graphical context.
  *  \param flag 0 hides the pointer, 1 shows the system's default pointer
  *              (usually an arrow). Other values are reserved for future use.