Remove documentation from header file

This commit is contained in:
Crayon2000 2020-12-14 00:42:18 -05:00
parent ba4e81852d
commit ef9b05c88d
3 changed files with 32 additions and 30 deletions

View file

@ -198,33 +198,3 @@ GRR_EXTERN u32 fb GRR_INIT(0);
#endif // __GRRLIB_H__ #endif // __GRRLIB_H__
/** @} */ // end of group /** @} */ // 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.
* It is essentially a wrapper which presents a friendly interface to the Nintendo GX core.
*
* @section Links
* Forum: http://grrlib.santo.fr/forum\n
* Code: https://github.com/GRRLIB/GRRLIB\n
* Chat: <a href="irc://irc.efnet.net/grrlib">\#GRRLIB</a> on EFnet
*
* @section Credits
* Project Leader : NoNameNo\n
* Documentation : Crayon, BlueChip\n
* Lead Coder : NoNameNo\n
* Support Coders : Crayon, Xane, DragonMinded, BlueChip\n
* Advisors : RedShade, Jespa\n
*
* @section Licence
* See the [LICENCE](LICENCE.md) file for licence rights and limitations (MIT).
*
* @example template/source/main.c
* This example shows the minimum code required to use GRRLIB.
* It could be used as a template to start a new project.
* More elaborate examples can be found inside the \e examples folder.
*/

31
docs/mainpage.dox Normal file
View file

@ -0,0 +1,31 @@
/**
* @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.
* It is essentially a wrapper which presents a friendly interface to the Nintendo GX core.
*
* @section Links
* Code: https://github.com/GRRLIB/GRRLIB\n
* Discussions: http://grrlib.santo.fr/forum\n
* Chat: <a href="irc://irc.efnet.net/grrlib">\#GRRLIB</a> on EFnet
*
* @section Credits
* Project Leader : NoNameNo\n
* Documentation : Crayon, BlueChip\n
* Lead Coder : NoNameNo\n
* Support Coders : Crayon, Xane, DragonMinded, BlueChip\n
* Advisors : RedShade, Jespa\n
*
* @section Licence
* See the [LICENCE](LICENCE.md) file for licence rights and limitations (MIT).
*
* @example template/source/main.c
* This example shows the minimum code required to use GRRLIB.
* It could be used as a template to start a new project.
* More elaborate examples can be found inside the \e examples folder.
*/

View file

@ -846,6 +846,7 @@ WARN_LOGFILE =
INPUT = ./GRRLIB/GRRLIB \ INPUT = ./GRRLIB/GRRLIB \
./GRRLIB/GRRLIB/grrlib \ ./GRRLIB/GRRLIB/grrlib \
./docs \
LICENCE.md \ LICENCE.md \
CHANGELOG.md CHANGELOG.md