From 7ed7b6b16bfdee30e7a396d69223de896c67f653 Mon Sep 17 00:00:00 2001 From: Crayon2000 Date: Thu, 2 Feb 2023 00:42:06 -0500 Subject: [PATCH] Update Doxyfile to v1.9.6 --- GRRLIB/GRRLIB/GRRLIB_3D.c | 2 +- GRRLIB/GRRLIB/GRRLIB_bmf.c | 2 +- README.md | 14 +++++++++-- grrlib.doxygen | 49 +++++++++++++++++++++++--------------- 4 files changed, 44 insertions(+), 23 deletions(-) diff --git a/GRRLIB/GRRLIB/GRRLIB_3D.c b/GRRLIB/GRRLIB/GRRLIB_3D.c index d9648a9..e7a8f5c 100644 --- a/GRRLIB/GRRLIB/GRRLIB_3D.c +++ b/GRRLIB/GRRLIB/GRRLIB_3D.c @@ -592,7 +592,7 @@ void GRRLIB_DrawCone(f32 r, f32 h, u16 d, bool filled, u32 col) { for(u16 i = 0; i <= d; i++) { const f32 dx = cosf( M_PI * 2.0f * i / d ); const f32 dy = sinf( M_PI * 2.0f * i / d ); - GX_Position3f32( 0, -0.5f * h,0); + GX_Position3f32( 0, -0.5f * h, 0); GX_Normal3f32( dx, 0.0f, dy ); GX_Color1u32(col); GX_Position3f32( r * dx, 0.5f * h, r * dy ); diff --git a/GRRLIB/GRRLIB/GRRLIB_bmf.c b/GRRLIB/GRRLIB/GRRLIB_bmf.c index 28210d1..7a88718 100644 --- a/GRRLIB/GRRLIB/GRRLIB_bmf.c +++ b/GRRLIB/GRRLIB/GRRLIB_bmf.c @@ -46,7 +46,7 @@ GRRLIB_bytemapFont* GRRLIB_LoadBMF (const u8 my_bmf[] ) { //u8 usedcolors = my_bmf[10]; //u8 highestcolor = my_bmf[11]; u8 nbPalette = my_bmf[16]; - short int numcolpal = 3 * nbPalette; + const short int numcolpal = 3 * nbPalette; fontArray->palette = (u32 *)calloc(nbPalette + 1, sizeof(u32)); for (u32 i=0; i < numcolpal; i+=3) { fontArray->palette[j++] = ((((my_bmf[i+17]<<2)+3)<<24) | (((my_bmf[i+18]<<2)+3)<<16) | (((my_bmf[i+19]<<2)+3)<<8) | 0xFF); diff --git a/README.md b/README.md index 243b569..29fb727 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ version" to a directory called C:\grr This guide is for Windows. If you are using Linux, I am going to presume you are smart enough to convert these instructions. + ```text GRRLIB is supplied as source code libpngu is supplied as source code @@ -80,8 +81,9 @@ libjpeg is supplied via devkitPro pacman (ppc-libjpeg-turbo) libfat is supplied via devkitPro pacman (libfat-ogc) ``` -The easy way is to install GRRLIB and all the required libraries in a single -command: +The easy way is to install GRRLIB and all the required libraries with a few +commands: + ```bash c: cd \grr\GRRLIB @@ -96,6 +98,7 @@ installed and you are ready to start developing Wii homebrew games. If you want, you could install the libfat, libpng, libfreetype and libjpeg with there dependencies in a single command: + ```bash pacman --sync --needed --noconfirm libfat-ogc ppc-libpng ppc-freetype ppc-libjpeg-turbo ``` @@ -103,6 +106,7 @@ libfreetype and libjpeg with there dependencies in a single command: Each library could also be installed individually: To install libpngu: + ```bash c: cd \grr\GRRLIB\lib\pngu @@ -110,6 +114,7 @@ To install libpngu: ``` To install libgrrlib for Wii: + ```bash c: cd \grr\GRRLIB\GRRLIB @@ -117,6 +122,7 @@ To install libgrrlib for Wii: ``` To install libgrrlib for GameCube: + ```bash c: cd \grr\GRRLIB\GRRLIB @@ -126,15 +132,19 @@ To install libgrrlib for GameCube: ## Using GRRLIB After everything is installed, simply put + ```c #include ``` + at the top of your .c/.cpp file and use the functions as required You will need to add + ```make -lgrrlib -lfreetype -lbz2 -lfat -ljpeg -lpngu -lpng -lz ``` + to the libs line in your makefile ...Remember the order of the libraries is critical. You may (need to) insert diff --git a/grrlib.doxygen b/grrlib.doxygen index 80983d8..505825b 100644 --- a/grrlib.doxygen +++ b/grrlib.doxygen @@ -1,4 +1,4 @@ -# Doxyfile 1.9.5 +# Doxyfile 1.9.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -86,7 +86,7 @@ CREATE_SUBDIRS = NO # level increment doubles the number of directories, resulting in 4096 # directories at level 8 which is the default and also the maximum value. The # sub-directories are organized in 2 levels, the first level always has a fixed -# numer of 16 directories. +# number of 16 directories. # Minimum value: 0, maximum value: 8, default value: 8. # This tag requires that the tag CREATE_SUBDIRS is set to YES. @@ -568,7 +568,8 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO @@ -859,6 +860,14 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = YES +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but @@ -1233,10 +1242,11 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = NO -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = @@ -1315,7 +1325,12 @@ HTML_STYLESHEET = # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @@ -1331,17 +1346,13 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output -# should be rendered with a dark or light theme. Default setting AUTO_LIGHT -# enables light output unless the user preference is dark output. Other options -# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to -# default to dark mode unless the user prefers light mode, and TOGGLE to let the -# user toggle between dark and light mode via a button. -# Possible values are: LIGHT Always generate light output., DARK Always generate -# dark output., AUTO_LIGHT Automatically set the mode according to the user -# preference, use light mode if no preference is set (the default)., AUTO_DARK -# Automatically set the mode according to the user preference, use dark mode if -# no preference is set. and TOGGLE Allow to user to switch between light and -# dark mode via a button.. +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. # The default value is: AUTO_LIGHT. # This tag requires that the tag GENERATE_HTML is set to YES.