From f57e01bcfecdf9f2476568ddc105a27a1d4a27b5 Mon Sep 17 00:00:00 2001 From: Crayon2000 Date: Fri, 4 Sep 2009 14:10:38 +0000 Subject: [PATCH] [CHG] Some parameters were missing for doxygen documentation --- GRRLIB/GRRLIB/GRRLIB_fileIO.c | 11 +++++------ GRRLIB/GRRLIB/grrlib.h | 4 ++-- grrlib.doxygen | 10 ++++++++-- 3 files changed, 15 insertions(+), 10 deletions(-) diff --git a/GRRLIB/GRRLIB/GRRLIB_fileIO.c b/GRRLIB/GRRLIB/GRRLIB_fileIO.c index 4f4d688..a2e0a87 100644 --- a/GRRLIB/GRRLIB/GRRLIB_fileIO.c +++ b/GRRLIB/GRRLIB/GRRLIB_fileIO.c @@ -23,10 +23,10 @@ THE SOFTWARE. #include /** - * Load a file to memory. The 2nd parameter is a pointer-to-your-pointer! - * Ie. { u8 *data; load("file",&data); }. It is your responsibility to free the - * memory allocated by this function. - * @param filename name of the file to be loaded. + * Load a file to memory. + * @param filename Name of the file to be loaded. + * @param data Pointer-to-your-pointer. Ie. { u8 *data; load("file", &data); }. + * It is your responsibility to free the memory allocated by this function. * @return int 0:EmptyFile, -1:FileNotFound, -2:OutOfMemory, -3:FileReadError, * >0 -> FileLength. */ @@ -61,7 +61,6 @@ int GRRLIB_LoadFile(const char* filename, unsigned char* *data) { return len; } - /** * Load a texture from a file. * @param filename The JPEG or PNG filename to load. @@ -86,7 +85,7 @@ GRRLIB_texImg* GRRLIB_LoadTextureFromFile(const char *filename) { /** * Make a PNG screenshot on the SD card. * libfat is required to use the function. - * @param File name of the file to write. + * @param filename name of the file to write. * @return bool true=everything worked, false=problems occurred. */ bool GRRLIB_ScrShot(const char* filename) { diff --git a/GRRLIB/GRRLIB/grrlib.h b/GRRLIB/GRRLIB/grrlib.h index 6286d11..d9d3716 100644 --- a/GRRLIB/GRRLIB/grrlib.h +++ b/GRRLIB/GRRLIB/grrlib.h @@ -194,8 +194,8 @@ GRRLIB_bytemapFont; #endif GRR_EXTERN GXRModeObj *rmode; -GRR_EXTERN void *xfb[2] GRR_INITS(NULL, NULL) ; -GRR_EXTERN u32 fb GRR_INIT(0) ; +GRR_EXTERN void *xfb[2] GRR_INITS(NULL, NULL); +GRR_EXTERN u32 fb GRR_INIT(0); //============================================================================== // procedure and function prototypes diff --git a/grrlib.doxygen b/grrlib.doxygen index af68e8d..036d107 100644 --- a/grrlib.doxygen +++ b/grrlib.doxygen @@ -1,4 +1,4 @@ -# Doxyfile 1.6.0 +# Doxyfile 1.6.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -481,6 +481,12 @@ 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. @@ -979,7 +985,7 @@ ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. -# If the tag value is set to FRAME, a side panel will be generated +# If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).