From 44fc7a04b546c5a79cf8ad06308c690cd117d2bd Mon Sep 17 00:00:00 2001 From: Sam Hocevar Date: Wed, 31 Dec 2003 14:21:08 +0000 Subject: [PATCH] * doc/doxygen.cfg.in: + Removed caca_internal.h from the list of documented files. * src/: + Minor documentation updates. --- doc/doxygen.cfg.in | 2 +- src/bitmap.c | 2 +- src/box.c | 2 +- src/caca.h | 22 +++++++++++----------- src/conic.c | 2 +- src/graphics.c | 2 +- src/io.c | 2 +- src/line.c | 2 +- src/math.c | 2 +- src/triangle.c | 2 +- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in index b076e37..af8b6ba 100644 --- a/doc/doxygen.cfg.in +++ b/doc/doxygen.cfg.in @@ -63,7 +63,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- INPUT = @top_srcdir@/src FILE_PATTERNS = *.c \ - *.h + caca.h RECURSIVE = YES EXCLUDE = ../src/config.h EXCLUDE_SYMLINKS = NO diff --git a/src/bitmap.c b/src/bitmap.c index 4ae9116..626d32f 100644 --- a/src/bitmap.c +++ b/src/bitmap.c @@ -22,7 +22,7 @@ /** \file bitmap.c * \version \$Id$ * \author Sam Hocevar - * \brief Bitmap functions + * \brief Bitmap blitting * * This file contains bitmap blitting functions. */ diff --git a/src/box.c b/src/box.c index e01e1cd..b85f056 100644 --- a/src/box.c +++ b/src/box.c @@ -22,7 +22,7 @@ /** \file box.c * \version \$Id$ * \author Sam Hocevar - * \brief Simple box drawing functions + * \brief Simple box drawing * * This file contains box drawing functions, both filled and outline. */ diff --git a/src/caca.h b/src/caca.h index e1a6a85..9a9beb6 100644 --- a/src/caca.h +++ b/src/caca.h @@ -104,7 +104,7 @@ extern "C" /** \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 { @@ -128,8 +128,8 @@ enum caca_color /** \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 { @@ -171,7 +171,7 @@ enum caca_feature /** \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 { @@ -185,8 +185,8 @@ enum caca_event /** \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 { @@ -230,7 +230,7 @@ void caca_refresh(void); void caca_end(void); /* @} */ -/** \defgroup event Event handling functions +/** \defgroup event Event handling * * These functions handle user events such as keyboard input and mouse * clicks. @@ -240,7 +240,7 @@ unsigned int caca_get_event(void); unsigned int caca_wait_event(void); /* @} */ -/** \defgroup char Character printing functions +/** \defgroup char Character printing * * These functions provide low-level character printing routines. * @@ -255,7 +255,7 @@ void caca_printf(int, int, const char *, ...); void caca_clear(void); /* @} */ -/** \defgroup prim Primitives drawing functions +/** \defgroup prim Primitives drawing * * These functions provide routines for primitive drawing, such as lines, * boxes, triangles and ellipses. @@ -289,7 +289,7 @@ int caca_rand(int, int); unsigned int caca_sqrt(unsigned int); /* @} */ -/** \defgroup sprite Sprite handling functions +/** \defgroup sprite Sprite handling * * These functions provide high level routines for sprite loading, animation * and rendering. @@ -306,7 +306,7 @@ void caca_draw_sprite(int, int, const struct caca_sprite *, int); void caca_free_sprite(struct caca_sprite *); /* @} */ -/** \defgroup bitmap Bitmap handling functions +/** \defgroup bitmap Bitmap handling * * These functions provide high level routines for bitmap allocation and * rendering. diff --git a/src/conic.c b/src/conic.c index 99b8623..7e2394c 100644 --- a/src/conic.c +++ b/src/conic.c @@ -22,7 +22,7 @@ /** \file conic.c * \version \$Id$ * \author Sam Hocevar - * \brief Ellipse and circle drawing functions + * \brief Ellipse and circle drawing * * This file contains ellipse and circle drawing functions, both filled * and outline. diff --git a/src/graphics.c b/src/graphics.c index d2e59b3..2f3c4ae 100644 --- a/src/graphics.c +++ b/src/graphics.c @@ -22,7 +22,7 @@ /** \file graphics.c * \version \$Id$ * \author Sam Hocevar - * \brief Character drawing functions + * \brief Character drawing * * This file contains character and string drawing functions. */ diff --git a/src/io.c b/src/io.c index f741d14..c1076c5 100644 --- a/src/io.c +++ b/src/io.c @@ -22,7 +22,7 @@ /** \file io.c * \version \$Id$ * \author Sam Hocevar - * \brief Event handling functions + * \brief Event handling * * This file contains event handling functions for keyboard and mouse input. */ diff --git a/src/line.c b/src/line.c index 106584b..5192641 100644 --- a/src/line.c +++ b/src/line.c @@ -22,7 +22,7 @@ /** \file line.c * \version \$Id$ * \author Sam Hocevar - * \brief Line drawing functions + * \brief Line drawing * * This file contains line and polyline drawing functions, with both thin * and thick styles. diff --git a/src/math.c b/src/math.c index f889520..9d93da7 100644 --- a/src/math.c +++ b/src/math.c @@ -22,7 +22,7 @@ /** \file math.c * \version \$Id$ * \author Sam Hocevar - * \brief Math functions + * \brief Math * * This file contains simple mathematical routines. */ diff --git a/src/triangle.c b/src/triangle.c index 138c4db..389699b 100644 --- a/src/triangle.c +++ b/src/triangle.c @@ -22,7 +22,7 @@ /** \file triangle.c * \version \$Id$ * \author Sam Hocevar - * \brief Triangle drawing functions + * \brief Triangle drawing * * This file contains triangle drawing functions, both filled and outline. */