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.

Sign up for GitHub

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

Jump to bottom

Doxygen + Documentation Maintenance #1626

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Doxygen + Documentation Maintenance #1626

wants to merge 12 commits into from

Commits on May 28, 2024

  1. Update docs CI checkout version 

    Node.js 16 is deprecated. Updating this to the latest version so that it continues working.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    b8e1708 View commit details
    Browse the repository at this point in the history

  2. Update docs CI gh-pages version 

    Node.js 16 is deprecated. Updating this to the latest version so that it continues working.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    0c4fbee View commit details
    Browse the repository at this point in the history

  3. Update DoxyFile to 1.11.0

    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    626f9fc View commit details
    Browse the repository at this point in the history

  4. Update Doxygen CI version to 1.11.0 (latest)

    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    c246396 View commit details
    Browse the repository at this point in the history

  5. Update Doxygen Awesome theme to 2.3.3 (latest)

    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    1899dec View commit details
    Browse the repository at this point in the history

  6. Fix Doxygen chipset "unexpected token" warnings 

    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.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    460d441 View commit details
    Browse the repository at this point in the history

  7. Disable Doxygen LATEX generation 

    This isn't used by the documentation and results in numerous errors in the output since `epstopdf` is not installed by default.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    f190c4d View commit details
    Browse the repository at this point in the history

  8. Add APA102 high definition documentation

    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    bdbb22d View commit details
    Browse the repository at this point in the history

  9. Add FASTLED_REGISTER docs 

    This also fixes a function definition which changed due to the FASTLED_REGISTER addition.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    d81cadb View commit details
    Browse the repository at this point in the history

  10. Update Doxygen Layout for 1.10.0 

    The change in naming of "modules" to "topics" broke the display of all groups.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    792b01c View commit details
    Browse the repository at this point in the history

  11. Fix PROGMEM function docs 

    Not sure why this macro expansion wasn't working, but adding the flag directly to the 'if' statements works fine.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    8a31ec2 View commit details
    Browse the repository at this point in the history

  12. Fix noise function documentation 

    This function changed its signature with FastLED#1619. This corrects the copydetails commands to the new signature.
    @dmadison
    dmadison committed May 28, 2024
    Configuration menu
    Copy the full SHA
    dafef24 View commit details
    Browse the repository at this point in the history