fix doxygen syms (#506)

* fix doxygen syms

* add the markdown file

.gitignore

@@ -84,4 +84,4 @@ expected/*
 !/assets/**/*custom*/**/*.bin
 
 # Doxygen
-docs/html/*
+docs/html/*

Doxyfile

@@ -945,7 +945,7 @@ WARN_LOGFILE           =
 
 INPUT                  = src/ \
                          include/ \
-                         tools/doxygen_syms.txt
+                         tools/doxygen_syms.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

Makefile

@@ -392,6 +392,10 @@ ifeq ($(COMPARE),1)
 	@$(SHA1SUM) --quiet -c $(TARGET).sha1 && $(PRINT) "$(TARGET): $(GREEN)OK$(NO_COL)\n" || ($(PRINT) "$(YELLOW)Building the ROM file has succeeded, but does not match the original ROM.\nThis is expected, and not an error, if you are making modifications.\nTo silence this message, use 'make COMPARE=0.' $(NO_COL)\n" && false)
 endif
 
+doc:
+	$(PYTHON) tools/doxygen_symbol_gen.py
+	doxygen
+
 clean:
 	$(RM) -r $(BUILD_DIR)
 

tools/doxygen_symbol_gen.py

@@ -1,12 +1,14 @@
+# usr/bin/python3
+
 def process_map_file(map_file_path):
     result = (
-        "/**\n"
+        "# Memory Addresses\n"
-        " * @page memory_addresses Memory Addresses\n"
+        "This page displays the memory addresses of variables in the project.\n"
-        " * This page displays the memory addresses of variables in the project.\n"
+        "\n"
-        " *\n"
+        "## Memory Addresses\n"
-        " * @section sec_addresses Memory Addresses\n"
+        "The following table shows the memory addresses of important variables:\n"
-        " * The following table shows the memory addresses of important variables:\n"
+        "Variable Name | Memory Address\n"
-        " * | Variable Name | Memory Address |\n"
+        "--------------|---------------\n"
     )
 
     with open(map_file_path, 'r') as file:
@@ -22,12 +24,12 @@ def process_map_file(map_file_path):
                     function_name = tokens[-1]
 
                     # Format the information into the Doxygen style
-                    result += f" * | {function_name} | {address} |\n"
+                    result += f"{function_name} | {address}\n"
 
     result += (
-        " *\n"
+        "\n"
-        " * @note This information is generated during the compilation process.\n"
+        "Note: This information is generated during the compilation process.\n"
-        " */\n"
+        "\n"
     )
 
     return result
@@ -38,7 +40,7 @@ if __name__ == "__main__":
     doxygen_formatted_content = process_map_file(map_file_path)
 
     # Specify the output file path
-    output_file_path = "tools/doxygen_syms.txt"
+    output_file_path = "tools/doxygen_syms.md"
 
     # Write the result to the output file
     with open(output_file_path, 'w') as output_file: