mirror of
https://github.com/GRRLIB/GRRLIB.git
synced 2024-11-22 15:02:20 +00:00
[CHG] Stop including all inline header files in the doc (duplicate declaration)
[CHG] Added the "Modules" section in the doc with all the functions in GRRLIB
This commit is contained in:
parent
5d28586ff2
commit
c138b0ede2
13 changed files with 21 additions and 12 deletions
|
@ -24,6 +24,12 @@ THE SOFTWARE.
|
||||||
* @file GRRLIB.h
|
* @file GRRLIB.h
|
||||||
* GRRLIB user include file
|
* GRRLIB user include file
|
||||||
*/
|
*/
|
||||||
|
/**
|
||||||
|
* @defgroup AllFunc Everything in GRRLIB
|
||||||
|
* This is the complete list of funtions, structures, defines, typedefs and enumerations you may want to used to make your homebrew with GRRLIB.
|
||||||
|
* You simply need to include grrlib.h in your project to have access to all of these.
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef __GRRLIB_H__
|
#ifndef __GRRLIB_H__
|
||||||
#define __GRRLIB_H__
|
#define __GRRLIB_H__
|
||||||
|
@ -198,11 +204,12 @@ GRR_EXTERN u32 fb GRR_INIT(0);
|
||||||
#endif /* __cplusplus */
|
#endif /* __cplusplus */
|
||||||
|
|
||||||
#endif // __GRRLIB_H__
|
#endif // __GRRLIB_H__
|
||||||
|
/** @} */ // end of group
|
||||||
/**
|
/**
|
||||||
* @mainpage GRRLIB Documentation
|
* @mainpage GRRLIB Documentation
|
||||||
* @image html grrlib_logo.png
|
* @image html grrlib_logo.png
|
||||||
* Welcome to the GRRLIB documentation.
|
* Welcome to the GRRLIB documentation.
|
||||||
|
* A complete list of functions is available from this \ref AllFunc "page".
|
||||||
*
|
*
|
||||||
* @section Introduction
|
* @section Introduction
|
||||||
* GRRLIB is a C/C++ 2D/3D graphics library for Wii application developers.
|
* GRRLIB is a C/C++ 2D/3D graphics library for Wii application developers.
|
||||||
|
|
|
@ -23,10 +23,15 @@ THE SOFTWARE.
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB__inline.h
|
* @file GRRLIB__inline.h
|
||||||
* GRRLIB inline function prototypes.
|
* GRRLIB inline function prototypes.
|
||||||
|
* Do not include GRRLIB__inline.h directly, include only GRRLIB.h.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* @addtogroup AllFunc
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef __GRRLIB_H__
|
#ifndef __GRRLIB_H__
|
||||||
# error Do not include GRRLIB_fnInline.h directly, include only GRRLIB.h
|
# error Do not include GRRLIB__inline.h directly, include only GRRLIB.h
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef __GRRLIB_FNINLINE_H__
|
#ifndef __GRRLIB_FNINLINE_H__
|
||||||
|
@ -132,3 +137,4 @@ INLINE void GRRLIB_FreeTexture (GRRLIB_texImg *tex);
|
||||||
#include <grrlib/GRRLIB_texSetup.h> // Setup for textures
|
#include <grrlib/GRRLIB_texSetup.h> // Setup for textures
|
||||||
|
|
||||||
#endif // __GRRLIB_FNINLINE_H__
|
#endif // __GRRLIB_FNINLINE_H__
|
||||||
|
/** @} */ // end of group
|
||||||
|
|
|
@ -23,6 +23,11 @@ THE SOFTWARE.
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB__lib.h
|
* @file GRRLIB__lib.h
|
||||||
* GRRLIB library function prototypes.
|
* GRRLIB library function prototypes.
|
||||||
|
* Do not include GRRLIB__lib.h directly, include only GRRLIB.h.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* @addtogroup AllFunc
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef __GRRLIB_H__
|
#ifndef __GRRLIB_H__
|
||||||
|
@ -162,3 +167,4 @@ unsigned int GRRLIB_WidthTTF(GRRLIB_ttfFont *myFont, const char *, unsigned int)
|
||||||
unsigned int GRRLIB_WidthTTFW(GRRLIB_ttfFont *myFont, const wchar_t *, unsigned int);
|
unsigned int GRRLIB_WidthTTFW(GRRLIB_ttfFont *myFont, const wchar_t *, unsigned int);
|
||||||
|
|
||||||
#endif // __GRRLIB_FNLIB_H__
|
#endif // __GRRLIB_FNLIB_H__
|
||||||
|
/** @} */ // end of group
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_cExtn.h
|
|
||||||
* Inline functions to offer additional C primitives.
|
* Inline functions to offer additional C primitives.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_clipping.h
|
|
||||||
* Inline functions to control clipping.
|
* Inline functions to control clipping.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_collision.h
|
|
||||||
* Inline functions for collision detection.
|
* Inline functions for collision detection.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_fbComplex.h
|
|
||||||
* Inline functions for complex (N-point) shape drawing.
|
* Inline functions for complex (N-point) shape drawing.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_fbGX.h
|
|
||||||
* Inline functions for interfacing directly to the GX Engine.
|
* Inline functions for interfacing directly to the GX Engine.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_fbSimple.h
|
|
||||||
* Inline functions for primitive point and line drawing.
|
* Inline functions for primitive point and line drawing.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_handle.h
|
|
||||||
* Inline functions for manipulating texture handles.
|
* Inline functions for manipulating texture handles.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_pixel.h
|
|
||||||
* Inline functions for manipulating pixels in textures.
|
* Inline functions for manipulating pixels in textures.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_settings.h
|
|
||||||
* Inline functions for configuring the GRRLIB settings.
|
* Inline functions for configuring the GRRLIB settings.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@ THE SOFTWARE.
|
||||||
------------------------------------------------------------------------------*/
|
------------------------------------------------------------------------------*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file GRRLIB_texSetup.h
|
|
||||||
* Inline functions for the basic manipulation of textures.
|
* Inline functions for the basic manipulation of textures.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue