Merge branch 'master' into misc-improvements

.github/workflows/docs.yaml

@@ -0,0 +1,21 @@
+name: Doxygen
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    name: Build and deploy documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build
+        uses: mattnotmitt/doxygen-action@v1
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/doxygen

.gitignore

@@ -17,3 +17,4 @@ assets
 *.bin
 bin/
 build/
+docs/doxygen/

.vscode/settings.json

@@ -12,4 +12,5 @@
         "-D_LANGUAGE_C",
     ],
     "python.pythonPath": "/usr/bin/python3",
+    "git.ignoreLimitWarning": true,
 }

Doxyfile

@@ -0,0 +1,112 @@
+# https://www.doxygen.nl/manual/config.html
+
+PROJECT_NAME           = "Paper Mario"
+PROJECT_NUMBER         =
+PROJECT_BRIEF          = "Decompilation of Paper Mario"
+PROJECT_LOGO           =
+
+OUTPUT_DIRECTORY       = docs
+CREATE_SUBDIRS         = NO
+ALLOW_UNICODE_NAMES    = YES
+
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+TYPEDEF_HIDES_STRUCT   = YES
+
+NUM_PROC_THREADS       = 0
+
+EXTRACT_ALL            = YES
+EXTRACT_STATIC         = YES
+HIDE_UNDOC_CLASSES     = NO
+HIDE_IN_BODY_DOCS      = YES
+SHOW_GROUPED_MEMB_INC  = YES
+
+FORCE_LOCAL_INCLUDES   = YES
+INLINE_INFO            = YES
+
+SORT_MEMBER_DOCS       = NO
+SORT_BRIEF_DOCS        = NO
+SORT_GROUP_NAMES       = NO
+
+GENERATE_TODOLIST      = NO
+GENERATE_TESTLIST      = NO
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= NO
+
+DISABLE_INDEX          = YES
+GENERATE_TREEVIEW      = YES
+
+ENABLED_SECTIONS       =
+MAX_INITIALIZER_LINES  = 1
+
+SHOW_INCLUDE_FILES     = NO
+SHOW_USED_FILES        = YES
+SHOW_FILES             = YES
+SHOW_NAMESPACES        = NO
+
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = NO
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_AS_ERROR          = YES
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           =
+
+INPUT                  = README.md src include
+FILE_PATTERNS          = *.c *.h
+RECURSIVE              = YES
+EXCLUDE                = include/nu include/PR include/ultra64.h
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       =
+EXCLUDE_SYMBOLS        =
+
+USE_MDFILE_AS_MAINPAGE = README.md
+
+SOURCE_BROWSER         = YES
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION    = NO
+REFERENCES_LINK_SOURCE = NO
+SOURCE_TOOLTIPS        = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = NO
+
+ALPHABETICAL_INDEX     = NO
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          =
+
+GENERATE_HTML          = YES
+HTML_OUTPUT            = doxygen
+HTML_HEADER            = docs/doxygen_header.html
+HTML_FOOTER            =
+HTML_EXTRA_STYLESHEET  = docs/doxygen_custom.css
+HTML_EXTRA_FILES       =
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_TIMESTAMP         = YES
+HTML_DYNAMIC_MENUS     = YES
+HTML_DYNAMIC_SECTIONS  = YES
+HTML_INDEX_NUM_ENTRIES = 100
+HTML_FORMULA_FORMAT    = svg
+
+USE_MATHJAX            = YES
+MATHJAX_FORMAT         = SVG
+
+SEARCHENGINE           = YES
+SERVER_BASED_SEARCH    = NO
+
+GENERATE_LATEX         = NO
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+PREDEFINED             = DOXYGEN NON_MATCHING __attribute__((x))=
+EXPAND_AS_DEFINED      = INCLUDE_ASM
+SKIP_FUNCTION_MACROS   = YES
+
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           = include include/PR src
+INCLUDE_FILE_PATTERNS  =

Makefile

@@ -69,7 +69,7 @@ submodules:
 	git submodule update --init --recursive
 
 split:
-	rm -rf $(DATA_DIRS) && $(SPLAT) --modes ld bin Yay0 PaperMarioMapFS
+	rm -rf bin && $(SPLAT) --modes ld bin Yay0 PaperMarioMapFS
 
 split-all:
 	rm -rf $(DATA_DIRS) && $(SPLAT) --modes all
@@ -109,7 +109,7 @@ $(LD_SCRIPT): $(TOOLS)/splat.yaml
 	$(SPLAT) --modes ld
 
 $(BUILD_DIR)/$(TARGET).elf: $(O_FILES) $(LD_SCRIPT)
-	@$(LD) $(LDFLAGS) -o $@ $(O_FILES)
+	$(LD) $(LDFLAGS) -o $@
 
 $(BUILD_DIR)/$(TARGET).bin: $(BUILD_DIR)/$(TARGET).elf
 	$(OBJCOPY) $< $@ -O binary

asm/nonmatchings/world/area_arn/arn_03/BDED90/func_80240B94_BDF924.s

@@ -167,7 +167,7 @@ glabel func_80240B94_BDF924
 /* BDFB94 80240E04 00000000 */   nop      
 /* BDFB98 80240E08 0280202D */  daddu     $a0, $s4, $zero
 /* BDFB9C 80240E0C 0260282D */  daddu     $a1, $s3, $zero
-/* BDFBA0 80240E10 0C090207 */  jal       func_8024081C_BDED90
+/* BDFBA0 80240E10 0C090207 */  jal       func_8024081C_BDF5AC
 /* BDFBA4 80240E14 02A0302D */   daddu    $a2, $s5, $zero
 /* BDFBA8 80240E18 0280202D */  daddu     $a0, $s4, $zero
 /* BDFBAC 80240E1C 0260282D */  daddu     $a1, $s3, $zero

asm/nonmatchings/world/area_arn/arn_04/BE37B0/func_80240B94_BE4344.s

@@ -167,7 +167,7 @@ glabel func_80240B94_BE4344
 /* BE45B4 80240E04 00000000 */   nop      
 /* BE45B8 80240E08 0280202D */  daddu     $a0, $s4, $zero
 /* BE45BC 80240E0C 0260282D */  daddu     $a1, $s3, $zero
-/* BE45C0 80240E10 0C090207 */  jal       func_8024081C_BE37B0
+/* BE45C0 80240E10 0C090207 */  jal       func_8024081C_BE3FCC
 /* BE45C4 80240E14 02A0302D */   daddu    $a2, $s5, $zero
 /* BE45C8 80240E18 0280202D */  daddu     $a0, $s4, $zero
 /* BE45CC 80240E1C 0260282D */  daddu     $a1, $s3, $zero

asm/nonmatchings/world/area_arn/arn_05/BE7BE0/func_80240B94_BE8774.s

@@ -167,7 +167,7 @@ glabel func_80240B94_BE8774
 /* BE89E4 80240E04 00000000 */   nop      
 /* BE89E8 80240E08 0280202D */  daddu     $a0, $s4, $zero
 /* BE89EC 80240E0C 0260282D */  daddu     $a1, $s3, $zero
-/* BE89F0 80240E10 0C090207 */  jal       func_8024081C_BE7BE0
+/* BE89F0 80240E10 0C090207 */  jal       func_8024081C_BE83FC
 /* BE89F4 80240E14 02A0302D */   daddu    $a2, $s5, $zero
 /* BE89F8 80240E18 0280202D */  daddu     $a0, $s4, $zero
 /* BE89FC 80240E1C 0260282D */  daddu     $a1, $s3, $zero