fries/GRRLIB
1
0
Fork 0
mirror of https://github.com/GRRLIB/GRRLIB.git synced 2024-11-22 06:52:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

[CHG] Some parameters were missing for doxygen documentation

Browse source
This commit is contained in:
Crayon2000 2009-09-04 14:10:38 +00:00
parent 711283033d
commit f57e01bcfe
3 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
GRRLIB/GRRLIB/GRRLIB_fileIO.c
View file

@ -23,10 +23,10 @@ THE SOFTWARE.
#include <stdio.h> #include <stdio.h>
/** /**
* Load a file to memory. The 2nd parameter is a pointer-to-your-pointer! * Load a file to memory.
* Ie. { u8 *data; load("file",&data); }. It is your responsibility to free the * @param filename Name of the file to be loaded.
* memory allocated by this function. * @param data Pointer-to-your-pointer. Ie. { u8 *data; load("file", &data); }.
* @param filename name of the file to be loaded. * It is your responsibility to free the memory allocated by this function.
* @return int 0:EmptyFile, -1:FileNotFound, -2:OutOfMemory, -3:FileReadError, * @return int 0:EmptyFile, -1:FileNotFound, -2:OutOfMemory, -3:FileReadError,
* >0 -> FileLength. * >0 -> FileLength.
*/ */
@ -61,7 +61,6 @@ int GRRLIB_LoadFile(const char* filename, unsigned char* *data) {
return len; return len;
} }
/** /**
* Load a texture from a file. * Load a texture from a file.
* @param filename The JPEG or PNG filename to load. * @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. * Make a PNG screenshot on the SD card.
* libfat is required to use the function. * 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. * @return bool true=everything worked, false=problems occurred.
*/ */
bool GRRLIB_ScrShot(const char* filename) { bool GRRLIB_ScrShot(const char* filename) {

10
grrlib.doxygen
View file

@ -1,4 +1,4 @@
# Doxyfile 1.6.0 # Doxyfile 1.6.1
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project
@ -481,6 +481,12 @@ ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30 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 # If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO. # 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 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. # 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 # containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports # 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). # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).