diff --git a/GRRLIB/GRRLIB/grrlib.h b/GRRLIB/GRRLIB/grrlib.h index 3502276..93ffa6d 100644 --- a/GRRLIB/GRRLIB/grrlib.h +++ b/GRRLIB/GRRLIB/grrlib.h @@ -24,6 +24,12 @@ THE SOFTWARE. * @file GRRLIB.h * 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__ #define __GRRLIB_H__ @@ -198,11 +204,12 @@ GRR_EXTERN u32 fb GRR_INIT(0); #endif /* __cplusplus */ #endif // __GRRLIB_H__ - +/** @} */ // end of group /** * @mainpage GRRLIB Documentation * @image html grrlib_logo.png * Welcome to the GRRLIB documentation. + * A complete list of functions is available from this \ref AllFunc "page". * * @section Introduction * GRRLIB is a C/C++ 2D/3D graphics library for Wii application developers. diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB__inline.h b/GRRLIB/GRRLIB/grrlib/GRRLIB__inline.h index a34d9e5..b7101ea 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB__inline.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB__inline.h @@ -23,10 +23,15 @@ THE SOFTWARE. /** * @file GRRLIB__inline.h * GRRLIB inline function prototypes. + * Do not include GRRLIB__inline.h directly, include only GRRLIB.h. + */ +/** + * @addtogroup AllFunc + * @{ */ #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 #ifndef __GRRLIB_FNINLINE_H__ @@ -132,3 +137,4 @@ INLINE void GRRLIB_FreeTexture (GRRLIB_texImg *tex); #include // Setup for textures #endif // __GRRLIB_FNINLINE_H__ +/** @} */ // end of group diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB__lib.h b/GRRLIB/GRRLIB/grrlib/GRRLIB__lib.h index 5056084..1113e73 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB__lib.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB__lib.h @@ -23,6 +23,11 @@ THE SOFTWARE. /** * @file GRRLIB__lib.h * GRRLIB library function prototypes. + * Do not include GRRLIB__lib.h directly, include only GRRLIB.h. + */ +/** + * @addtogroup AllFunc + * @{ */ #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); #endif // __GRRLIB_FNLIB_H__ +/** @} */ // end of group diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_cExtn.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_cExtn.h index c143f61..71bc662 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_cExtn.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_cExtn.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_cExtn.h * Inline functions to offer additional C primitives. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_clipping.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_clipping.h index 836a049..f4b195e 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_clipping.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_clipping.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_clipping.h * Inline functions to control clipping. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_collision.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_collision.h index c116e25..71052e3 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_collision.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_collision.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_collision.h * Inline functions for collision detection. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_fbComplex.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_fbComplex.h index 3cfb60c..fec486e 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_fbComplex.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_fbComplex.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_fbComplex.h * Inline functions for complex (N-point) shape drawing. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_fbGX.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_fbGX.h index f682e00..030ea84 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_fbGX.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_fbGX.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_fbGX.h * Inline functions for interfacing directly to the GX Engine. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_fbSimple.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_fbSimple.h index f62a6ae..e54e819 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_fbSimple.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_fbSimple.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_fbSimple.h * Inline functions for primitive point and line drawing. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_handle.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_handle.h index 4d5e69c..b919d38 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_handle.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_handle.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_handle.h * Inline functions for manipulating texture handles. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_pixel.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_pixel.h index 05d57b2..56c425a 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_pixel.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_pixel.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_pixel.h * Inline functions for manipulating pixels in textures. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_settings.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_settings.h index 148b01e..a235f9f 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_settings.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_settings.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_settings.h * Inline functions for configuring the GRRLIB settings. */ diff --git a/GRRLIB/GRRLIB/grrlib/GRRLIB_texSetup.h b/GRRLIB/GRRLIB/grrlib/GRRLIB_texSetup.h index 9b0e92a..bd1c365 100644 --- a/GRRLIB/GRRLIB/grrlib/GRRLIB_texSetup.h +++ b/GRRLIB/GRRLIB/grrlib/GRRLIB_texSetup.h @@ -21,7 +21,6 @@ THE SOFTWARE. ------------------------------------------------------------------------------*/ /** - * @file GRRLIB_texSetup.h * Inline functions for the basic manipulation of textures. */