diff --git a/.gitignore b/.gitignore index bd79c043b6..b7d17125ab 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ venv/ .DS_Store ctx.c expected/ +docs/ # Assets assets diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000000..a851835620 --- /dev/null +++ b/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 = YES +REFERENCES_LINK_SOURCE = NO +SOURCE_TOOLTIPS = NO +USE_HTAGS = NO +VERBATIM_HEADERS = NO + +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = + +GENERATE_HTML = YES +HTML_OUTPUT = doxygen +HTML_HEADER = +HTML_FOOTER = +HTML_EXTRA_STYLESHEET = +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 = 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 = diff --git a/install.sh b/install.sh index cc7f568767..efbc4324cc 100755 --- a/install.sh +++ b/install.sh @@ -9,7 +9,7 @@ if command -v apt &> /dev/null; then if [[ $1 == "--extra" ]]; then echo "Installing extra" - sudo apt install -y clang-tidy astyle || exit 1 + sudo apt install -y clang-tidy astyle doxygen || exit 1 python3 -m pip install -U -r requirements_extra.txt || exit 1 fi @@ -50,7 +50,7 @@ if command -v pacman &> /dev/null; then if [[ $1 == "--extra" ]]; then echo "Installing extra" - sudo pacman -S --noconfirm --needed clang astyle || exit 1 + sudo pacman -S --noconfirm --needed clang astyle doxygen || exit 1 python3 -m pip install -U -r requirements_extra.txt || exit 1 fi @@ -85,7 +85,7 @@ if command -v zypper &> /dev/null; then if [[ $1 == "--extra" ]]; then echo "Installing extra" - sudo zypper -n install clang astyle || exit 1 + sudo zypper -n install clang astyle doxygen || exit 1 python3 -m pip install -U -r requirements_extra.txt || exit 1 fi @@ -141,7 +141,7 @@ if command -v apk &> /dev/null; then if [[ $1 == "--extra" ]]; then echo "Installing extra" - sudo apk add --no-cache clang-extra-tools astyle || exit 1 + sudo apk add --no-cache clang-extra-tools astyle doxygen || exit 1 python3 -m pip install -U -r requirements_extra.txt || exit 1 fi