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

Fix warnings and clean up public API headers #12

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

Fix warnings and clean up public API headers #12

wants to merge 6 commits into from

Commits on Aug 22, 2022

  1. Delete trailing whitespace

    @drobilla
    drobilla committed Aug 22, 2022
    Configuration menu
    Copy the full SHA
    6ce9c00 View commit details
    Browse the repository at this point in the history

  2. Use a consistent style for copyright headers 

    I chose the most common one here, although the indentation is a bit odd.
    @drobilla
    drobilla committed Aug 22, 2022
    Configuration menu
    Copy the full SHA
    b601e3d View commit details
    Browse the repository at this point in the history

  3. Clean up include guards 

    The previous style(s) used in most places here violates the C standard, and in
practice can trigger -Wreserved-id-macro in clang for client code.  So, switch
to a conventional style that doesn't trigger warnings (and is supported by
tools like clang-tidy).
    @drobilla
    drobilla committed Aug 22, 2022
    Configuration menu
    Copy the full SHA
    fe0ab49 View commit details
    Browse the repository at this point in the history

  4. Fix invalid/unusual documentation comment syntax 

    Collectively, these trigger warnings in both Doxygen and
clang (-Wdocumentation-unknown-command).  Weirdly, @p in doxygen doesn't do
anything but print in a fixed-width font anyway, so just use Markdown quotes to
replace it which has the same effect (and reads nicer in the source).  The use
of @param like @p was invalid, so do the same to those.
    @drobilla
    drobilla committed Aug 22, 2022
    Configuration menu
    Copy the full SHA
    4371aab View commit details
    Browse the repository at this point in the history

  5. Remove documentation for non-existent parameter

    @drobilla
    drobilla committed Aug 22, 2022
    Configuration menu
    Copy the full SHA
    d339468 View commit details
    Browse the repository at this point in the history

  6. Avoid clash with "register" keyword 

    This fixes a Doxygen warning where a (seemingly) non-existent parameter was
documented.
    @drobilla
    drobilla committed Aug 22, 2022
    Configuration menu
    Copy the full SHA
    9130d18 View commit details
    Browse the repository at this point in the history