Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen #1142

Merged
merged 13 commits into from
Jan 9, 2024
Merged

Doxygen #1142

merged 13 commits into from
Jan 9, 2024

Conversation

bates64
Copy link
Member

@bates64 bates64 commented Jan 8, 2024

It's back baby!

Closes #275.

Requires HOST, USERNAME, PASSWORD actions secrets similar to pmret/website @ethteck

@bates64
Copy link
Member Author

bates64 commented Jan 8, 2024

ftr this is passing, there was an issue in a splat release that has since been yanked

@bates64 bates64 merged commit 37f5987 into main Jan 9, 2024
2 of 3 checks passed
@bates64 bates64 deleted the doxygen branch January 9, 2024 23:56
bates64 added a commit that referenced this pull request Jan 10, 2024
* use doxygen
* add documenting guide based on https://github.com/zeldaret/oot/blob/main/docs/Documenting.md
* exclude stdlib readme from doxygen
* refuse to configure matching iQue on macOS (EGCS compiler is not built for macOS, so iQue won't build. We still enable iQue builds on macOS by using gcc-papermario via --non-matching.)
* use proper doxygen bug comment style
* document common EVT API funcs nicely
* add doxygen ci
* add \vars command
ethteck pushed a commit that referenced this pull request Jan 11, 2024
* support modded NPC sprites

- improve compatibility with Star Rod SpriteSheet.xml files
  - SR's intention is to move to the decomp xml but the current release of SR emitted incompatible xml
- use npc.xml instead of npc_sprite_names.yaml to generate linker entries. this allows mods to add new sprites

* black

why does it want two spaces before line comments!?

* Doxygen (#1142)

* use doxygen
* add documenting guide based on https://github.com/zeldaret/oot/blob/main/docs/Documenting.md
* exclude stdlib readme from doxygen
* refuse to configure matching iQue on macOS (EGCS compiler is not built for macOS, so iQue won't build. We still enable iQue builds on macOS by using gcc-papermario via --non-matching.)
* use proper doxygen bug comment style
* document common EVT API funcs nicely
* add doxygen ci
* add \vars command

* s/master/main

* use Doxygen 1.10.0

* fix doxygen ci

* fix doxygen ci

* fix doxygen (final)

* fix doxygen (final real)

* Fix Doxygen CI (#1147)

* remove old doxygen ci line

* fix warns

Thanks @Ponmander for reporting this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation site generation (Doxygen / Docco)
1 participant