Changeset 298Tweet

Timestamp:

Dec 31, 2003, 3:21:08 PM (17 years ago)

Author:

Sam Hocevar

Message:

• doc/doxygen.cfg.in: + Removed caca_internal.h from the list of documented files.
• src/: + Minor documentation updates.

Location:

libcaca/trunk

Files:

• doc/doxygen.cfg.in (modified) (1 diff)
• src/bitmap.c (modified) (1 diff)
• src/box.c (modified) (1 diff)
• src/caca.h (modified) (9 diffs)
• src/conic.c (modified) (1 diff)
• src/graphics.c (modified) (1 diff)
• src/io.c (modified) (1 diff)
• src/line.c (modified) (1 diff)
• src/math.c (modified) (1 diff)
• src/triangle.c (modified) (1 diff)

libcaca/trunk/doc/doxygen.cfg.in

@@ -64 +64 @@
 INPUT                  = @top_srcdir@/src
 FILE_PATTERNS          = *.c \
-                         *.h
+                         caca.h
 RECURSIVE              = YES
 EXCLUDE                = ../src/config.h

libcaca/trunk/src/bitmap.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Bitmap functions
+ *  \brief Bitmap blitting
  *
  *  This file contains bitmap blitting functions.

libcaca/trunk/src/box.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Simple box drawing functions
+ *  \brief Simple box drawing
  *
  *  This file contains box drawing functions, both filled and outline.

libcaca/trunk/src/caca.h

@@ -105 +105 @@
 /** \brief Colour definitions.
  *
- *  This enum lists all colours that can be used with caca_set_color().
+ *  Colours that can be used with caca_set_color().
  */
 enum caca_color
@@ -129 +129 @@
 /** \brief Internal features.
  *
- *  This enum lists all possible internal libcaca features such as the
- *  rendering method or the dithering mode.
+ *  Internal libcaca features such as the rendering method or the dithering
+ *  mode.
  */
 enum caca_feature
@@ -172 +172 @@
 /** \brief User events.
  *
- *  This enum lists all possible event types returned by caca_get_event().
+ *  Event types returned by caca_get_event().
  */
 enum caca_event
@@ -186 +186 @@
 /** \brief Special key values.
  *
- *  This enum lists special key values returned by caca_get_event() for
- *  which there is no ASCII equivalent.
+ *  Special key values returned by caca_get_event() for which there is no
+ *  ASCII equivalent.
  */
 enum caca_key
@@ -231 +231 @@
 /*  @} */
 
-/** \defgroup event Event handling functions
+/** \defgroup event Event handling
  *
  *  These functions handle user events such as keyboard input and mouse
@@ -241 +241 @@
 /*  @} */
 
-/** \defgroup char Character printing functions
+/** \defgroup char Character printing
  *
  *  These functions provide low-level character printing routines.
@@ -256 +256 @@
 /*  @} */
 
-/** \defgroup prim Primitives drawing functions
+/** \defgroup prim Primitives drawing
  *
  *  These functions provide routines for primitive drawing, such as lines,
@@ -290 +290 @@
 /*  @} */
 
-/** \defgroup sprite Sprite handling functions
+/** \defgroup sprite Sprite handling
  *
  *  These functions provide high level routines for sprite loading, animation
@@ -307 +307 @@
 /*  @} */
 
-/** \defgroup bitmap Bitmap handling functions
+/** \defgroup bitmap Bitmap handling
  *
  *  These functions provide high level routines for bitmap allocation and

libcaca/trunk/src/conic.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Ellipse and circle drawing functions
+ *  \brief Ellipse and circle drawing
  *
  *  This file contains ellipse and circle drawing functions, both filled

libcaca/trunk/src/graphics.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Character drawing functions
+ *  \brief Character drawing
  *
  *  This file contains character and string drawing functions.

libcaca/trunk/src/io.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Event handling functions
+ *  \brief Event handling
  *
  *  This file contains event handling functions for keyboard and mouse input.

libcaca/trunk/src/line.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Line drawing functions
+ *  \brief Line drawing
  *
  *  This file contains line and polyline drawing functions, with both thin

libcaca/trunk/src/math.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Math functions
+ *  \brief Math
  *
  *  This file contains simple mathematical routines.

libcaca/trunk/src/triangle.c

@@ -23 +23 @@
  *  \version \$Id$
  *  \author Sam Hocevar <sam@zoy.org>
- *  \brief Triangle drawing functions
+ *  \brief Triangle drawing
  *
  *  This file contains triangle drawing functions, both filled and outline.