-
Notifications
You must be signed in to change notification settings - Fork 12
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
Add doxygen infrastructure #83
Conversation
4e7febd
to
7dd7e16
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
host/System.cc
also has ties to the base game, as KSystem
is modeled loosely on RKSystem
. The corresponding addresses are as follows:
KSystem::main
- 80008ef0
KSystem::init
- 80009194
KSystem::run
- 8000951c
Accounted for all of @vabold's comments above. Also applied the following changes (some may be duplicates of vabold's comments)
|
Updated! |
Doxygen will be an incredible resource to have as we expand Kinoko, in terms of test cases, coverage, and collaboration. In this PR, I've left comments for most functions that I felt comfortable describing, with the hope that the rest can be filled in over time.
The following is all features I've implemented that I can think of:
@rename
alias: Leaves a note in the documentation that the function has a poor name and should be renamed in the future@unused
alias: Adds[unused]
in the documentation@todo
alias: Duh@addr
alias: Displays a function's address as a "qualifier" to the right of the function signature@stage
alias: Adds bolded text in the documentation to specify what stage of the race the function (can) run during. This may not be fully present in parts of the documentation I've added...KColData::GetVertex
andEGG::Quatf::dot
Future improvements:
I'd like to establish the following precedents:
@addr{0x80XXXXXX}
command that maps that function to its in-game counterpart (if applicable).@beginSetters
...@endSetters
and@beginGetters
...@endGetters
.