[CHG] Modification for Doxygen documentation

This commit is contained in:
Crayon2000 2009-08-19 17:47:29 +00:00
parent 5e186828b0
commit 515b4a994a
5 changed files with 31 additions and 30 deletions

View file

@ -89,12 +89,14 @@ typedef unsigned int uint;
// Primitive colour macros
//==============================================================================
// Feel free to convert these to inline functions if it floats your boat
#define R(c) (((c) >>24) &0xFF) // Exract RED component of colour
#define G(c) (((c) >>16) &0xFF) // Exract GREEN component of colour
#define B(c) (((c) >> 8) &0xFF) // Exract BLUE component of colour
#define A(c) ( (c) &0xFF) // Exract ALPHA component of colour
#define R(c) (((c) >>24) &0xFF) /**< Exract RED component of colour. */
#define G(c) (((c) >>16) &0xFF) /**< Exract GREEN component of colour. */
#define B(c) (((c) >> 8) &0xFF) /**< Exract BLUE component of colour. */
#define A(c) ( (c) &0xFF) /**< Exract ALPHA component of colour. */
// Build an RGB pixel from components
/**
* Build an RGB pixel from components.
*/
#define RGBA(r,g,b,a) ( (u32)( ( ((u32)(r)) <<24) | \
((((u32)(g)) &0xFF) <<16) | \
((((u32)(b)) &0xFF) << 8) | \
@ -104,17 +106,15 @@ typedef unsigned int uint;
// typedefs, enumerators & structs
//==============================================================================
/**
* Compositions Modes
* NORMAL : a-over-b alpha composition (normal)
* ...more to come
* Compositions Modes.
*/
typedef enum Composition_Modes {
GRRLIB_COMPOSE_NORMAL,
GRRLIB_COMPOSE_NORMAL, /**< NORMAL : a-over-b alpha composition (normal) */
} GRRLIB_ComposeMode;
//------------------------------------------------------------------------------
/**
* GRRLIB Blending Modes
* GRRLIB Blending Modes.
*/
typedef enum GRRLIB_blendMode {
GRRLIB_BLEND_ALPHA = 0, /**< Alpha Blending. */
@ -180,8 +180,6 @@ typedef struct GRRLIB_bytemapChar {
*/
typedef
struct GRRLIB_bytemapFont {
//! the order of the fields here is changed
//! to encourage efficient structure packing in the compiler
char *name; /**< Font name. */
u32 *palette; /**< Font palette. */
u16 nbChar; /**< Number of characters in font. */

View file

@ -21,7 +21,7 @@ THE SOFTWARE.
------------------------------------------------------------------------------*/
/**
* @file GRRLIB_fnLibrary.h
* @file GRRLIB__inline.h
* GRRLIB inline functions.
*/

View file

@ -21,7 +21,7 @@ THE SOFTWARE.
------------------------------------------------------------------------------*/
/**
* @file GRRLIB_fnLibrary.h
* @file GRRLIB__lib.h
* GRRLIB library functions.
*/

View file

@ -1,4 +1,4 @@
# Doxyfile 1.5.8
# Doxyfile 1.5.9
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
@ -31,7 +31,7 @@ PROJECT_NAME = GRRLIB
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 4.0.0
PROJECT_NUMBER = 4.1.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
@ -54,11 +54,11 @@ CREATE_SUBDIRS = NO
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
# Spanish, Swedish, and Ukrainian.
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
@ -224,7 +224,8 @@ OPTIMIZE_OUTPUT_VHDL = NO
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C
# use: inc=Fortran f=C. Note that for custom extensions you also need to set
# FILE_PATTERNS otherwise the files are not read by doxygen.
EXTENSION_MAPPING =
@ -470,12 +471,6 @@ ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
@ -573,7 +568,8 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = .\GRRLIB\GRRLIB
INPUT = .\GRRLIB\GRRLIB \
.\GRRLIB\GRRLIB\grrlib
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -1078,6 +1074,13 @@ LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
# source code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings
# such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
@ -1476,7 +1479,7 @@ DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
DOT_PATH = "../../Program Files/Graphviz/bin"
DOT_PATH = "C:\Program Files\Graphviz\bin"
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.8 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB