Changeset 128Tweet

Timestamp:

Nov 10, 2003, 4:16:38 PM (17 years ago)

Author:

Sam Hocevar

Message:

• libee/line.c: + Added code comments.

File:

• ttyvaders/trunk/libee/line.c (modified) (6 diffs)

ttyvaders/trunk/libee/line.c

@@ -41 +41 @@
 static void draw_thin_line(struct line*);
 
+/**
+ * \brief Draw a line on the screen using the given character.
+ *
+ * \param x1 X coordinate of the first point.
+ * \param y1 Y coordinate of the first point.
+ * \param x2 X coordinate of the second point.
+ * \param y2 Y coordinate of the second point.
+ * \param c Character to draw the line with.
+ * \return nothing
+ */
 void ee_draw_line(int x1, int y1, int x2, int y2, char c)
 {
@@ -53 +63 @@
 }
 
+/**
+ * \brief Draw a thin line on the screen, using ASCII art.
+ *
+ * \param x1 X coordinate of the first point.
+ * \param y1 Y coordinate of the first point.
+ * \param x2 X coordinate of the second point.
+ * \param y2 Y coordinate of the second point.
+ * \return nothing
+ */
 void ee_draw_thin_line(int x1, int y1, int x2, int y2)
 {
@@ -64 +83 @@
 }
 
+/**
+ * \brief Generic Cohen-Sutherland line clipping function.
+ *
+ * \param s a line structure
+ * \return nothing
+ */
 static void clip_line(struct line* s)
 {
@@ -115 +140 @@
 }
 
+/**
+ * \brief Helper function for clip_line().
+ *
+ * \param x X coordinate of the point.
+ * \param y Y coordinate of the point.
+ * \return b The clipping bits for the given point.
+ */
 static uint8_t clip_bits(int x, int y)
 {
@@ -132 +164 @@
 }
 
+/**
+ * \brief Solid line drawing function, using Bresenham's mid-point line
+ *        scan-conversion algorithm.
+ *
+ * \param s a line structure
+ * \return nothing
+ */
 static void draw_solid_line(struct line* s)
 {
@@ -194 +233 @@
 }
 
+/**
+ * \brief Thin line drawing function, using Bresenham's mid-point line
+ *        scan-conversion algorithm and ASCII art graphics.
+ *
+ * \param s a line structure
+ * \return nothing
+ */
 static void draw_thin_line(struct line* s)
 {