Doxygen + Documentation Maintenance #1626
Open
Conversation
This file contains 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
Node.js 16 is deprecated. Updating this to the latest version so that it continues working.
Node.js 16 is deprecated. Updating this to the latest version so that it continues working.
Starting with Doxygen 1.9.5, running Doxygen would result in a host of warnings: "warning: unexpected token TK_COMMAND_BS as the argument of \ifile". These doxygen warnings were pointing to lines in `chipsets.h`, which was confusing since these seem to be properly documented? It turns out that this was due to the inline comments for the chipsets in `FastLED.h` using copydoc, and referencing their base classes. This appears to be a bug in Doxygen. Changing these single-line definitions to multi-line (with the associated multi-line comments) fixes the issue and gets rid of the warnings. I'll follow up with a bug report on the Doxygen repo.
This isn't used by the documentation and results in numerous errors in the output since `epstopdf` is not installed by default.
This also fixes a function definition which changed due to the FASTLED_REGISTER addition.
The change in naming of "modules" to "topics" broke the display of all groups.
Not sure why this macro expansion wasn't working, but adding the flag directly to the 'if' statements works fine.
This function changed its signature with FastLED#1619. This corrects the copydetails commands to the new signature.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates Doxygen and its CI dependencies to the latest version:
The Doxyfile has also been updated to 1.11.0, and the Doxygen layout file (
DoxygenLayout.xml) has been updated to support the change of "Modules" to "Topics". The two documentation CI actions were updated to their latest versions, as the previous versions are using Node 16 which is now deprecated.This PR also fixes an issue where inline class documentation was generating warnings for Doxygen (460d441). I've also fixed a few minor documentation issues related to recent PRs (#1461, #1619).
There are no (intended) functional changes to the codebase. Documentation should be regenerated from GitHub Actions after this is merged.