Changeset 257 for libcaca/trunk/src/box.cTweet

Timestamp:

Dec 18, 2003, 1:11:52 AM (18 years ago)

Author:

Sam Hocevar

Message:

• src/: + Doxygenated public functions.

File:

• libcaca/trunk/src/box.c (modified) (3 diffs)

libcaca/trunk/src/box.c

@@ -35 +35 @@
 #include "caca_internals.h"
 
+/**
+ * \brief Draw a box on the screen using the given character.
+ *
+ * \param x1 X coordinate of the upper-left corner of the box.
+ * \param y1 Y coordinate of the upper-left corner of the box.
+ * \param x2 X coordinate of the lower-right corner of the box.
+ * \param y2 Y coordinate of the lower-right corner of the box.
+ * \param c Character to draw the box outline with.
+ * \return void
+ */
 void caca_draw_box(int x1, int y1, int x2, int y2, char c)
 {
@@ -43 +53 @@
 }
 
+/**
+ * \brief Draw a thin box on the screen.
+ *
+ * \param x1 X coordinate of the upper-left corner of the box.
+ * \param y1 Y coordinate of the upper-left corner of the box.
+ * \param x2 X coordinate of the lower-right corner of the box.
+ * \param y2 Y coordinate of the lower-right corner of the box.
+ * \return void
+ */
 void caca_draw_thin_box(int x1, int y1, int x2, int y2)
 {
@@ -96 +115 @@
 }
 
+/**
+ * \brief Fill a box on the screen using the given character.
+ *
+ * \param x1 X coordinate of the upper-left corner of the box.
+ * \param y1 Y coordinate of the upper-left corner of the box.
+ * \param x2 X coordinate of the lower-right corner of the box.
+ * \param y2 Y coordinate of the lower-right corner of the box.
+ * \param c Character to fill the box with.
+ * \return void
+ */
 void caca_fill_box(int x1, int y1, int x2, int y2, char c)
 {