From 9c155f042dd714e62a2858a79d785e3bd9233ceb Mon Sep 17 00:00:00 2001 From: Sam Hocevar Date: Sun, 4 Nov 2007 11:59:54 +0000 Subject: [PATCH] * Renamed doxygen sections here and there to avoid embarassing side-effects such as "man tutorial" showing the libcaca tutorial on Debian systems. --- AUTHORS | 2 +- NEWS | 2 +- THANKS | 2 +- TODO | 2 +- caca/caca.h | 4 ++-- cucul/cucul.h | 23 ++++++++++++----------- doc/canvas.dox | 2 +- doc/font.dox | 2 +- doc/libcaca.dox | 20 ++++++++++---------- doc/migrating.dox | 2 +- doc/style.dox | 2 +- doc/tutorial.dox | 2 +- doc/user.dox | 2 +- 13 files changed, 34 insertions(+), 33 deletions(-) diff --git a/AUTHORS b/AUTHORS index 29fab53..2121b42 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,4 +1,4 @@ -/* $Id$ */ /** \page authors Authors +/* $Id$ */ /** \page libcaca-authors Libcaca authors Sam Hocevar - main programmer diff --git a/NEWS b/NEWS index 88ee6e6..b8e996e 100644 --- a/NEWS +++ b/NEWS @@ -1,4 +1,4 @@ -/* $Id$ */ /** \page news News +/* $Id$ */ /** \page libcaca-news Libcaca news \section news0_99_beta12 Changes between 0.9.beta12 and 0.99.beta11 diff --git a/THANKS b/THANKS index 87a8544..a312701 100644 --- a/THANKS +++ b/THANKS @@ -1,4 +1,4 @@ -/* $Id$ */ /** \page thanks Thanks +/* $Id$ */ /** \page libcaca-thanks Libcaca thanks \section thanks1 Bugfixes and improvements diff --git a/TODO b/TODO index bc90b72..28a69cb 100644 --- a/TODO +++ b/TODO @@ -1,4 +1,4 @@ -/* $Id$ */ /** \page todo TODO list +/* $Id$ */ /** \page libcaca-todo Libcaca TODO list \section libcucul libcucul diff --git a/caca/caca.h b/caca/caca.h index 0736265..4f0148b 100644 --- a/caca/caca.h +++ b/caca/caca.h @@ -174,7 +174,7 @@ enum caca_key CACA_KEY_F15 = 0x128 /**< The F15 key. */ }; -/** \defgroup caca libcaca basic functions +/** \defgroup libcaca libcaca basic functions * * These functions provide the basic \e libcaca routines for driver * initialisation, system information retrieval and configuration. @@ -190,7 +190,7 @@ unsigned int caca_get_display_height(caca_display_t *); int caca_set_display_title(caca_display_t *, char const *); /* @} */ -/** \defgroup event libcaca event handling +/** \defgroup caca_event libcaca event handling * * These functions handle user events such as keyboard input and mouse * clicks. diff --git a/cucul/cucul.h b/cucul/cucul.h index b0a9bfc..a6a96e2 100644 --- a/cucul/cucul.h +++ b/cucul/cucul.h @@ -39,7 +39,7 @@ typedef struct cucul_dither cucul_dither_t; /** font structure */ typedef struct cucul_font cucul_font_t; -/** \defgroup attr_defines libcucul attribute definitions +/** \defgroup cucul_attr libcucul attribute definitions * * Colours and styles that can be used with cucul_set_attr(). * @@ -69,7 +69,7 @@ typedef struct cucul_font cucul_font_t; #define CUCUL_BLINK 0x08 /**< The style mask for blink. */ /* @} */ -/** \defgroup cucul libcucul basic functions +/** \defgroup libcucul libcucul basic functions * * These functions provide the basic \e libcaca routines for library * initialisation, system information retrieval and configuration. @@ -83,7 +83,7 @@ int cucul_free_canvas(cucul_canvas_t *); int cucul_rand(int, int); /* @} */ -/** \defgroup canvas libcucul canvas drawing +/** \defgroup cucul_canvas libcucul canvas drawing * * These functions provide low-level character printing routines and * higher level graphics functions. @@ -112,7 +112,7 @@ int cucul_set_canvas_boundaries(cucul_canvas_t *, int, int, unsigned int, unsigned int); /* @} */ -/** \defgroup transform libcucul canvas transformation +/** \defgroup cucul_transform libcucul canvas transformation * * These functions perform horizontal and vertical canvas flipping. * @@ -127,7 +127,7 @@ int cucul_stretch_left(cucul_canvas_t *); int cucul_stretch_right(cucul_canvas_t *); /* @} */ -/** \defgroup attributes libcucul attribute conversions +/** \defgroup cucul_attributes libcucul attribute conversions * * These functions perform conversions between attribute values. * @@ -137,7 +137,7 @@ unsigned char cucul_attr_to_ansi_fg(unsigned long int); unsigned char cucul_attr_to_ansi_bg(unsigned long int); /* @} */ -/** \defgroup charset libcucul character set conversions +/** \defgroup cucul_charset libcucul character set conversions * * These functions perform conversions between usual character sets. * @@ -150,7 +150,7 @@ char cucul_utf32_to_ascii(unsigned long int); int cucul_utf32_is_fullwidth(unsigned long int); /* @} */ -/** \defgroup prim libcucul primitives drawing +/** \defgroup cucul_primitives libcucul primitives drawing * * These functions provide routines for primitive drawing, such as lines, * boxes, triangles and ellipses. @@ -180,7 +180,7 @@ int cucul_fill_triangle(cucul_canvas_t *, int, int, int, int, int, int, unsigned long int); /* @} */ -/** \defgroup frame libcucul canvas frame handling +/** \defgroup cucul_frame libcucul canvas frame handling * * These functions provide high level routines for canvas frame insertion, * removal, copying etc. @@ -194,7 +194,7 @@ int cucul_create_frame(cucul_canvas_t *, unsigned int); int cucul_free_frame(cucul_canvas_t *, unsigned int); /* @} */ -/** \defgroup dither libcucul bitmap dithering +/** \defgroup cucul_dither libcucul bitmap dithering * * These functions provide high level routines for dither allocation and * rendering. @@ -228,7 +228,7 @@ int cucul_dither_bitmap(cucul_canvas_t *, int, int, int, int, int cucul_free_dither(cucul_dither_t *); /* @} */ -/** \defgroup font libcucul font handling +/** \defgroup cucul_font libcucul font handling * * These functions provide font handling routines and high quality * canvas to bitmap rendering. @@ -244,7 +244,8 @@ int cucul_render_canvas(cucul_canvas_t *, cucul_font_t *, void *, int cucul_free_font(cucul_font_t *); /* @} */ -/** \defgroup importexport libcucul importers/exporters from/to various formats +/** \defgroup cucul_importexport libcucul importers/exporters from/to various + * formats * * These functions import various file formats into a new canvas, or export * the current canvas to various text formats. diff --git a/doc/canvas.dox b/doc/canvas.dox index fed4752..d7104ff 100644 --- a/doc/canvas.dox +++ b/doc/canvas.dox @@ -1,6 +1,6 @@ /* $Id$ */ -/** \page canvas The libcaca canvas format (version 1) +/** \page libcaca-canvas The libcaca canvas format (version 1) All types are big endian. diff --git a/doc/font.dox b/doc/font.dox index c5e79b7..ee58411 100644 --- a/doc/font.dox +++ b/doc/font.dox @@ -1,6 +1,6 @@ /* $Id$ */ -/** \page font The libcaca font format (version 1) +/** \page libcaca-font The libcaca font format (version 1) All types are big endian. diff --git a/doc/libcaca.dox b/doc/libcaca.dox index 1c541b8..5b40566 100644 --- a/doc/libcaca.dox +++ b/doc/libcaca.dox @@ -35,25 +35,25 @@ Some other topics are covered by specific sections: - - \subpage tutorial - - \subpage migrating + - \subpage libcaca-tutorial + - \subpage libcaca-migrating There is also information specially targeted at \e libcaca developers: - - \subpage font - - \subpage canvas - - \subpage style + - \subpage libcaca-font + - \subpage libcaca-canvas + - \subpage libcaca-style \section user User's documentation - - \subpage env + - \subpage libcaca-env \section misc Misc - - \subpage news - - \subpage authors - - \subpage thanks - - \subpage todo + - \subpage libcaca-news + - \subpage libcaca-authors + - \subpage libcaca-thanks + - \subpage libcaca-todo \section license License diff --git a/doc/migrating.dox b/doc/migrating.dox index ab22324..fe155b8 100644 --- a/doc/migrating.dox +++ b/doc/migrating.dox @@ -1,6 +1,6 @@ /* $Id$ */ -/** \page migrating Migrating from libcaca 0.x to the 1.0 API +/** \page libcaca-migrating Migrating from libcaca 0.x to the 1.0 API This section will guide you through the migration of a \e libcaca 0.x application to the latest API version. diff --git a/doc/style.dox b/doc/style.dox index 606f59f..5da16dd 100644 --- a/doc/style.dox +++ b/doc/style.dox @@ -1,6 +1,6 @@ /* $Id$ */ -/** \page style Coding style +/** \page libcaca-style Libcaca coding style \section sty1 General guidelines diff --git a/doc/tutorial.dox b/doc/tutorial.dox index 4b0dea5..8e14f58 100644 --- a/doc/tutorial.dox +++ b/doc/tutorial.dox @@ -1,6 +1,6 @@ /* $Id$ */ -/** \page tutorial A libcucul and libcaca tutorial +/** \page libcaca-tutorial A libcucul and libcaca tutorial Before writing your first libcaca application, you need to know the difference between libcucul and libcaca : - libcucul is the text rendering library. It will do all the work you actually need. From imports (text, ANSI, caca internal format, all of this supporting n-bytes unicode), to exports (sames formats, adding SVG, PostScript, TGA, HTML (both 3 and 4), IRC), it'll cover all your needs. diff --git a/doc/user.dox b/doc/user.dox index 70ed91a..c1c8ff9 100644 --- a/doc/user.dox +++ b/doc/user.dox @@ -1,6 +1,6 @@ /* $Id$ */ -/** \page env Environment variables +/** \page libcaca-env Libcaca environment variables Some environment variables can be used to change the behaviour of \e libcaca without having to modify the program which uses them. These