+ Removed caca_internal.h from the list of documented files. * src/: + Minor documentation updates.tags/v0.99.beta14
@@ -63,7 +63,7 @@ WARN_LOGFILE = | |||||
#--------------------------------------------------------------------------- | #--------------------------------------------------------------------------- | ||||
INPUT = @top_srcdir@/src | INPUT = @top_srcdir@/src | ||||
FILE_PATTERNS = *.c \ | FILE_PATTERNS = *.c \ | ||||
*.h | |||||
caca.h | |||||
RECURSIVE = YES | RECURSIVE = YES | ||||
EXCLUDE = ../src/config.h | EXCLUDE = ../src/config.h | ||||
EXCLUDE_SYMLINKS = NO | EXCLUDE_SYMLINKS = NO | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file bitmap.c | /** \file bitmap.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | ||||
* \brief Bitmap functions | |||||
* \brief Bitmap blitting | |||||
* | * | ||||
* This file contains bitmap blitting functions. | * This file contains bitmap blitting functions. | ||||
*/ | */ | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file box.c | /** \file box.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \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. | * This file contains box drawing functions, both filled and outline. | ||||
*/ | */ | ||||
@@ -104,7 +104,7 @@ extern "C" | |||||
/** \brief Colour definitions. | /** \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 | enum caca_color | ||||
{ | { | ||||
@@ -128,8 +128,8 @@ enum caca_color | |||||
/** \brief Internal features. | /** \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 | enum caca_feature | ||||
{ | { | ||||
@@ -171,7 +171,7 @@ enum caca_feature | |||||
/** \brief User events. | /** \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 | enum caca_event | ||||
{ | { | ||||
@@ -185,8 +185,8 @@ enum caca_event | |||||
/** \brief Special key values. | /** \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 | enum caca_key | ||||
{ | { | ||||
@@ -230,7 +230,7 @@ void caca_refresh(void); | |||||
void caca_end(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 | * These functions handle user events such as keyboard input and mouse | ||||
* clicks. | * clicks. | ||||
@@ -240,7 +240,7 @@ unsigned int caca_get_event(void); | |||||
unsigned int caca_wait_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. | * These functions provide low-level character printing routines. | ||||
* | * | ||||
@@ -255,7 +255,7 @@ void caca_printf(int, int, const char *, ...); | |||||
void caca_clear(void); | void caca_clear(void); | ||||
/* @} */ | /* @} */ | ||||
/** \defgroup prim Primitives drawing functions | |||||
/** \defgroup prim Primitives drawing | |||||
* | * | ||||
* These functions provide routines for primitive drawing, such as lines, | * These functions provide routines for primitive drawing, such as lines, | ||||
* boxes, triangles and ellipses. | * boxes, triangles and ellipses. | ||||
@@ -289,7 +289,7 @@ int caca_rand(int, int); | |||||
unsigned int caca_sqrt(unsigned 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 | * These functions provide high level routines for sprite loading, animation | ||||
* and rendering. | * and rendering. | ||||
@@ -306,7 +306,7 @@ void caca_draw_sprite(int, int, const struct caca_sprite *, int); | |||||
void caca_free_sprite(struct caca_sprite *); | 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 | * These functions provide high level routines for bitmap allocation and | ||||
* rendering. | * rendering. | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file conic.c | /** \file conic.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \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 | * This file contains ellipse and circle drawing functions, both filled | ||||
* and outline. | * and outline. | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file graphics.c | /** \file graphics.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | ||||
* \brief Character drawing functions | |||||
* \brief Character drawing | |||||
* | * | ||||
* This file contains character and string drawing functions. | * This file contains character and string drawing functions. | ||||
*/ | */ | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file io.c | /** \file io.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | ||||
* \brief Event handling functions | |||||
* \brief Event handling | |||||
* | * | ||||
* This file contains event handling functions for keyboard and mouse input. | * This file contains event handling functions for keyboard and mouse input. | ||||
*/ | */ | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file line.c | /** \file line.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | ||||
* \brief Line drawing functions | |||||
* \brief Line drawing | |||||
* | * | ||||
* This file contains line and polyline drawing functions, with both thin | * This file contains line and polyline drawing functions, with both thin | ||||
* and thick styles. | * and thick styles. | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file math.c | /** \file math.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | ||||
* \brief Math functions | |||||
* \brief Math | |||||
* | * | ||||
* This file contains simple mathematical routines. | * This file contains simple mathematical routines. | ||||
*/ | */ | ||||
@@ -22,7 +22,7 @@ | |||||
/** \file triangle.c | /** \file triangle.c | ||||
* \version \$Id$ | * \version \$Id$ | ||||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | ||||
* \brief Triangle drawing functions | |||||
* \brief Triangle drawing | |||||
* | * | ||||
* This file contains triangle drawing functions, both filled and outline. | * This file contains triangle drawing functions, both filled and outline. | ||||
*/ | */ | ||||