Resolve all Doxygen warnings & docs cleanup#8361
Open
rubiefawn wants to merge 4 commits into
Open
Conversation
rubiefawn
marked this pull request as ready for review
April 22, 2026 05:39
rubiefawn
force-pushed
the
fix/docs
branch
3 times, most recently
from
May 18, 2026 08:31
2287fbf to
926f938
Compare
rubiefawn
force-pushed
the
fix/docs
branch
4 times, most recently
from
June 4, 2026 21:23
e8b5333 to
1d49e1b
Compare
rubiefawn
commented
Jun 4, 2026
rubiefawn
added
the
needs code review
Contributor
|
From reading this, I think I'm now convinced that using |
yohannd1
reviewed
Jul 10, 2026
yohannd1
reviewed
Jul 10, 2026
Contributor
|
Read everything, hopefully I didn't miss anything. Looks alright imo, have my (weak) approval. |
- Updates Doxyfile for Doxygen 1.16.1 and minifies Doxyfile - Use PROJECT_LOGO & PROJECT_ICON in Doxyfile - Add custom Doxygen CSS to make the SVG logo behave - Add custom Doxygen CSS to make fonts more consistent - Move documentation comments in first-party code from source files to their corresponding headers, where applicable - Resolves several (but not all) Doxygen warnings in first-party code - Remove unused INPUTDIRS from doc/CMakeLists.txt - Use CMake's DOXYGEN_ADD_DOCS() instead of a custom doc target
rubiefawn
force-pushed
the
fix/docs
branch
4 times, most recently
from
July 15, 2026 01:52
d656b08 to
3a888fc
Compare
They are not required as long as there are no other trailing doc comments (see https://www.doxygen.nl/manual/docblocks.html#memberdoc)
rubiefawn
force-pushed
the
fix/docs
branch
2 times, most recently
from
July 16, 2026 17:07
6df9388 to
2ef1ea2
Compare
This contains only bugfixes except for one commit, which removes unnecessary typedefs. Importantly, it fixes the Doxygen warnings. MidiImport.cpp is modified to account for the removal of the typedefs.
I missed these earlier since they're not a git submodule lol
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
portsmfsubmodule in order to resolve Doxygen warnings fixed upstream