From 5f756ec1f98aa4c69edf621024010cd0ea89c7d8 Mon Sep 17 00:00:00 2001 From: Crayon2000 Date: Wed, 25 May 2022 00:10:17 -0400 Subject: [PATCH] Update Doxyfile to v1.9.4 --- .github/workflows/ci.yml | 2 +- GRRLIB/GRRLIB/GRRLIB_3D.c | 2 +- examples/3D_Light1/source/main.c | 2 +- examples/3D_Light4/source/main.c | 2 +- examples/NEED_GRRLIB_FUNCTION/source/main.c | 27 ++++---- examples/unlimited2d/source/main.c | 4 +- examples/unlimited3d/source/main.c | 5 +- grrlib.doxygen | 68 +++++++++++++++------ 8 files changed, 72 insertions(+), 40 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 265a257..c6db14f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,8 +18,8 @@ jobs: - name: Build library and examples run: | (cd GRRLIB && make clean all install) - (cd examples && make) (cd GRRLIB/GRRLIB && make PLATFORM=cube clean all install) + (cd examples && make) - uses: actions/upload-artifact@master with: diff --git a/GRRLIB/GRRLIB/GRRLIB_3D.c b/GRRLIB/GRRLIB/GRRLIB_3D.c index b352d30..95da1ef 100644 --- a/GRRLIB/GRRLIB/GRRLIB_3D.c +++ b/GRRLIB/GRRLIB/GRRLIB_3D.c @@ -184,7 +184,7 @@ void GRRLIB_ObjectViewScale(f32 scalx, f32 scaly, f32 scalz) { } /** - * Rotate the object matrix to draw object . + * Rotate the object matrix to draw object. * @param angx x rotation angle of the object. * @param angy y rotation angle of the object. * @param angz z rotation angle of the object. diff --git a/examples/3D_Light1/source/main.c b/examples/3D_Light1/source/main.c index b659b27..b7e13a3 100644 --- a/examples/3D_Light1/source/main.c +++ b/examples/3D_Light1/source/main.c @@ -38,7 +38,7 @@ int main() { GRRLIB_Camera3dSettings(0.0f,0.0f,camZ, 0,1,0, 0,0,0); GRRLIB_SetLightAmbient(0x333333FF); - GRRLIB_3dMode(0.1, 1000, 45, 0, 1); + GRRLIB_3dMode(0.1, 1000, 45, 0, 1); if(WPAD_ButtonsHeld(0) & WPAD_BUTTON_A) { // Set all light off to get the sphere no light sourced (only get the vertex color) diff --git a/examples/3D_Light4/source/main.c b/examples/3D_Light4/source/main.c index f4fe52f..a4e1d65 100644 --- a/examples/3D_Light4/source/main.c +++ b/examples/3D_Light4/source/main.c @@ -1,6 +1,6 @@ /*=========================================== GRRLIB - Spot Light Sample Code + Spot Light Sample Code ============================================*/ #include diff --git a/examples/NEED_GRRLIB_FUNCTION/source/main.c b/examples/NEED_GRRLIB_FUNCTION/source/main.c index 4b98f1f..4e97957 100644 --- a/examples/NEED_GRRLIB_FUNCTION/source/main.c +++ b/examples/NEED_GRRLIB_FUNCTION/source/main.c @@ -20,13 +20,13 @@ extern Mtx _GRR_view; int main() { -f32 a= 0.0f; -GXLightObj MyLight0; -GXLightObj MyLight1; -int demo=0; + f32 a = 0.0f; + GXLightObj MyLight0; + GXLightObj MyLight1; + int demo = 0; -Mtx mr,mv,rx,ry,rz,m; -GXTexObj texObj; + Mtx mr,mv,rx,ry,rz,m; + GXTexObj texObj; GRRLIB_Init(); WPAD_Init(); @@ -42,7 +42,7 @@ GXTexObj texObj; GRRLIB_SetBackgroundColour(0x40, 0x40, 0x40, 0xFF); while(1) { - GRRLIB_Camera3dSettings(0.0f,0.0f,10.0f, 0,1,0, 0,0,0); + GRRLIB_Camera3dSettings(0.0f,0.0f,10.0f, 0,1,0, 0,0,0); GRRLIB_2dMode(); WPAD_ScanPads(); @@ -52,7 +52,7 @@ GXTexObj texObj; GRRLIB_3dMode(0.1,1000,45,0,1); - if(demo==0){ + if(demo==0) { /////////////////// DEFINE A DIFUSE LIGHT ///////////////////////////////////////////// guVector l0pos={0.0f,20.0f,0.0f}; guVecMultiply(_GRR_view, &l0pos, &l0pos); @@ -81,7 +81,7 @@ GXTexObj texObj; GRRLIB_Printf(20, 30, tex_font, 0xFFFFFFFF, 1, "Simple Demo 1 Diffuse Light Source"); } - if(demo==1){ + if(demo==1) { /////////////////// DEFINE 2 DIFUSE LIGHTS ///////////////////////////////////////////// guVector l0pos={0.0f,20.0f,0.0f}; guVecMultiply(_GRR_view, &l0pos, &l0pos); @@ -118,7 +118,7 @@ GXTexObj texObj; GRRLIB_Printf(20, 30, tex_font, 0xFFFFFFFF, 1, "Simple Demo 2 Diffuse Light Sources"); } - if(demo==2){ + if(demo==2) { /////////////////// DEFINE A SPECUALR LIGHT ///////////////////////////////////////////// guVector l0dir={0.0f,0.0f,0.0f}; GX_InitSpecularDir(&MyLight0, l0dir.x,l0dir.y,l0dir.z); @@ -158,7 +158,7 @@ GXTexObj texObj; GRRLIB_Printf(20, 30, tex_font, 0xFFFFFFFF, 1, "Simple Demo 1 Specular Source with shininess = 20"); } - if(demo==3){ + if(demo==3) { /////////////////// DEFINE A SPECUALR LIGHT ///////////////////////////////////////////// guVector l0dir={0.0f,0.0f,0.0f}; GX_InitSpecularDir(&MyLight0, l0dir.x,l0dir.y,l0dir.z); @@ -197,7 +197,7 @@ GXTexObj texObj; GRRLIB_2dMode(); GRRLIB_Printf(20, 30, tex_font, 0xFFFFFFFF, 1, "Simple Demo 1 Specular Source with shininess = 200"); } - if(demo==4){ + if(demo==4) { GX_SetTexCoordGen(GX_TEXCOORD0, GX_TG_MTX3x4, GX_TG_NRM, GX_TEXMTX0); // We say we use the Normal coord to map the texture (since there is no textcoord with this torus) guLightFrustum(mv, 1.0F, -1.0F, 1.0F, -1.0F, 1.0F, 0.5F, 0.5F, 0.5F, 0.5F); // we are projecting the texture like a light (ie : videoprojector)) @@ -219,7 +219,7 @@ GXTexObj texObj; GRRLIB_2dMode(); GRRLIB_Printf(20, 30, tex_font, 0xFFFFFFFF, 1, "Simple Demo Mapping Using textgen from normal coord"); } - if(demo==5){ + if(demo==5) { GX_SetTexCoordGen(GX_TEXCOORD0, GX_TG_MTX3x4, GX_TG_NRM, GX_TEXMTX0); // We say we use the Normal coord to map the texture (since there is no textcoord with this torus) guLightFrustum(mv, 1.0F, -1.0F, 1.0F, -1.0F, 1.0F, 0.5F, 0.5F, 0.5F, 0.5F); // we are projecting the texture like a light (ie : videoprojector)) guMtxRotDeg(rx, 'X', a); // Here i rotate the texture @@ -256,4 +256,3 @@ GXTexObj texObj; exit(0); } - diff --git a/examples/unlimited2d/source/main.c b/examples/unlimited2d/source/main.c index 38234da..66c4707 100644 --- a/examples/unlimited2d/source/main.c +++ b/examples/unlimited2d/source/main.c @@ -65,8 +65,8 @@ int main() { GRRLIB_DrawImg(0, 0, tex_screen[screen_index], 0, 1, 1, 0xFFFFFFFF); GRRLIB_DrawImg(((R + r-ff)*cos(t-f) - d*cos(((R + r-f)/r)*t))+rmode->fbWidth/2-32, ((R + r-ff)*sin(t) - d*sin(((R + r)/r)*t)-f)+rmode->efbHeight/2-32, tex_ball, 1, 1, 1, 0xFFFFFFFF); GRRLIB_Screen2Texture(0, 0, tex_screen[screen_index], GX_FALSE); - GRRLIB_Printf((640-(16*6*5))/2+5, 200+5, tex_font, 0x00000088, 5, "%06d",(int)spr); - GRRLIB_Printf((640-(16*6*5))/2, 200, tex_font, 0xFFEEEE88, 5, "%06d",(int)spr); + GRRLIB_Printf((640-(16*6*5))/2+5, 200+5, tex_font, 0x00000088, 5, "%06d", (int)spr); + GRRLIB_Printf((640-(16*6*5))/2, 200, tex_font, 0xFFEEEE88, 5, "%06d", (int)spr); GRRLIB_Render(); screen_index++; diff --git a/examples/unlimited3d/source/main.c b/examples/unlimited3d/source/main.c index 223c7c0..e017c13 100644 --- a/examples/unlimited3d/source/main.c +++ b/examples/unlimited3d/source/main.c @@ -161,8 +161,8 @@ int main() { GRRLIB_2dMode(); GRRLIB_Screen2Texture(0, 0, tex_screen[screen_index], GX_FALSE); - GRRLIB_Printf((640-(16*6*5))/2+5, 200+5, tex_font, 0x00000088, 5, "%06d",(int)spr); - GRRLIB_Printf((640-(16*6*5))/2, 200, tex_font, 0xFFEEEE88, 5, "%06d",(int)spr); + GRRLIB_Printf((640-(16*6*5))/2+5, 200+5, tex_font, 0x00000088, 5, "%06d", (int)spr); + GRRLIB_Printf((640-(16*6*5))/2, 200, tex_font, 0xFFEEEE88, 5, "%06d", (int)spr); GRRLIB_Render(); screen_index++; @@ -193,4 +193,3 @@ int main() { return 0; } - diff --git a/grrlib.doxygen b/grrlib.doxygen index f3e10cb..3dec7d1 100644 --- a/grrlib.doxygen +++ b/grrlib.doxygen @@ -1,4 +1,4 @@ -# Doxyfile 1.9.3 +# Doxyfile 1.9.4 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -12,6 +12,15 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options @@ -60,16 +69,28 @@ PROJECT_LOGO = OUTPUT_DIRECTORY = -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# 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. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode @@ -81,14 +102,14 @@ ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English @@ -452,7 +473,7 @@ TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing @@ -577,7 +598,7 @@ INTERNAL_DOCS = NO # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly # deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with +# are not case sensitive the option should be set to NO to properly deal with # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On @@ -851,10 +872,21 @@ WARN_AS_ERROR = NO # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). In case the file specified cannot be opened for writing the @@ -2239,7 +2271,8 @@ SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the -# preprocessor. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = @@ -2408,7 +2441,8 @@ CLASS_GRAPH = YES COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# groups, showing the direct groups dependencies. See also the chapter Grouping +# in the manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES.