Skip to content

Commit a39e139

Browse files
committed
docs: Add doxygen
1 parent 6f45a81 commit a39e139

3 files changed

Lines changed: 86 additions & 0 deletions

File tree

.github/workflows/doxygen.yaml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Deploy Doxygen to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: true
15+
16+
jobs:
17+
build-and-deploy:
18+
environment:
19+
name: github-pages
20+
url: ${{ steps.deployment.outputs.page_url }}
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- name: Checkout Repository
25+
uses: actions/checkout@v4
26+
27+
- name: Install Doxygen
28+
run: |
29+
sudo apt-get update && sudo apt-get install -y graphviz
30+
wget https://github.com/doxygen/doxygen/releases/download/Release_1_14_0/doxygen-1.14.0.linux.bin.tar.gz
31+
tar -xzf doxygen-1.14.0.linux.bin.tar.gz
32+
sudo mv doxygen-1.14.0/bin/doxygen /usr/local/bin/doxygen
33+
doxygen -v
34+
35+
- name: Fetch Tagfiles
36+
run: |
37+
wget https://nsmbu.github.io/sead/sead.tag -O sead.tag
38+
39+
- name: Generate Documentation
40+
run: doxygen
41+
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v4
44+
45+
- name: Upload Artifact
46+
uses: actions/upload-pages-artifact@v3
47+
with:
48+
path: './docs/html'
49+
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
.vscode
33
.cache
44
*.sh
5+
docs

Doxyfile

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
PROJECT_NAME = "New Super Mario Bros. U Headers"
2+
OUTPUT_DIRECTORY = docs
3+
INPUT = actor/ ami/ audio/ boss/ bullet/ collision/ course_select/ distant_view/ effect/ enemy/ event/ fragment/ fukidashi/ game/ game_info/ graphics/ input/ item/ layout/ layout_sys/ map/ map_obj/ player/ scene/ scroll/ sound/ state/ system/ tag/ utility/
4+
EXCLUDE_PATTERNS =
5+
EXCLUDE_SYMBOLS =
6+
PREDEFINED = cafe
7+
TAGFILES = sead.tag=https://nsmbu.github.io/sead/
8+
GENERATE_TAGFILE = docs/html/headers.tag
9+
RECURSIVE = YES
10+
JAVADOC_BANNER = YES
11+
EXTRACT_ALL = YES
12+
EXTRACT_PRIVATE = YES
13+
EXTRACT_PRIV_VIRTUAL = YES
14+
EXTRACT_STATIC = YES
15+
SHOW_INCLUDE_FILES = NO
16+
SORT_MEMBER_DOCS = NO
17+
SORT_MEMBERS_CTORS_1ST = YES
18+
SORT_BY_SCOPE_NAME = YES
19+
GENERATE_DEPRECATEDLIST= NO
20+
MAX_INITIALIZER_LINES = 64
21+
SHOW_USED_FILES = NO
22+
SHOW_FILES = YES
23+
WARN_IF_INCOMPLETE_DOC = NO
24+
SOURCE_BROWSER = YES
25+
INLINE_SOURCES = YES
26+
CLANG_ASSISTED_PARSING = YES
27+
CLANG_OPTIONS =
28+
HTML_COLORSTYLE = AUTO_DARK
29+
HTML_COLORSTYLE_HUE = 200
30+
HTML_COLORSTYLE_SAT = 120
31+
HTML_DYNAMIC_SECTIONS = YES
32+
FULL_SIDEBAR = YES
33+
CLASS_GRAPH = TEXT

0 commit comments

Comments
 (0)