From ef9b05c88db7bcdbff676102818d252afe7545e9 Mon Sep 17 00:00:00 2001 From: Crayon2000 Date: Mon, 14 Dec 2020 00:42:18 -0500 Subject: [PATCH] Remove documentation from header file --- GRRLIB/GRRLIB/grrlib.h | 30 ------------------------------ docs/mainpage.dox | 31 +++++++++++++++++++++++++++++++ grrlib.doxygen | 1 + 3 files changed, 32 insertions(+), 30 deletions(-) create mode 100644 docs/mainpage.dox diff --git a/GRRLIB/GRRLIB/grrlib.h b/GRRLIB/GRRLIB/grrlib.h index ac27d3e..6eb2f77 100644 --- a/GRRLIB/GRRLIB/grrlib.h +++ b/GRRLIB/GRRLIB/grrlib.h @@ -198,33 +198,3 @@ GRR_EXTERN u32 fb GRR_INIT(0); #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. - * 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: \#GRRLIB 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. - */ diff --git a/docs/mainpage.dox b/docs/mainpage.dox new file mode 100644 index 0000000..c55e8f8 --- /dev/null +++ b/docs/mainpage.dox @@ -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: \#GRRLIB 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. + */ + \ No newline at end of file diff --git a/grrlib.doxygen b/grrlib.doxygen index 6cc2789..0c2d5cd 100644 --- a/grrlib.doxygen +++ b/grrlib.doxygen @@ -846,6 +846,7 @@ WARN_LOGFILE = INPUT = ./GRRLIB/GRRLIB \ ./GRRLIB/GRRLIB/grrlib \ + ./docs \ LICENCE.md \ CHANGELOG.md