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

Timestamp:

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

Author:

Sam Hocevar

Message:

• src/: + Doxygenated public functions.

File:

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

libcaca/trunk/src/line.c

@@ -77 +77 @@
 }
 
+/**
+ * \brief Draw a polyline on the screen using the given character and
+ *        coordinate arrays. The first and last points are not connected,
+ *        so in order to draw a polygon you need to specify the starting
+ *        point at the end of the list as well.
+ *
+ * \param x Array of X coordinates. Must have \p n + 1 elements.
+ * \param y Array of Y coordinates. Must have \p n + 1 elements.
+ * \param n Number of lines to draw.
+ * \param c Character to draw the lines with.
+ * \return void
+ */
 void caca_draw_polyline(const int x[], const int y[], int n, char c)
 {
@@ -114 +126 @@
 }
 
+/**
+ * \brief Draw a thin polyline on the screen using the given coordinate
+ *        arrays and with ASCII art. The first and last points are not
+ *        connected, so in order to draw a polygon you need to specify the
+ *        starting point at the end of the list as well.
+ *
+ * \param x Array of X coordinates. Must have \p n + 1 elements.
+ * \param y Array of Y coordinates. Must have \p n + 1 elements.
+ * \param n Number of lines to draw.
+ * \return void
+ */
 void caca_draw_thin_polyline(const int x[], const int y[], int n)
 {
@@ -196 +219 @@
  * \param x X coordinate of the point.
  * \param y Y coordinate of the point.
- * \return b The clipping bits for the given point.
+ * \return The clipping bits for the given point.
  */
 static uint8_t clip_bits(int x, int y)