Fix warnings and clean up public API headers #12
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
I chose the most common one here, although the indentation is a bit odd.
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).
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.
This fixes a Doxygen warning where a (seemingly) non-existent parameter was documented.
|
@falkTX Going over my open tickets/PRs, this one seems relatively uncontroversial. It'd be nice to at least get the warning fixes in there; thoughts? |
|
yeah I need to start merging jack stuff and do releases, which for the headers needs to be done on both jack1 and jack2 side so the eventual headers repo reusage does not become a big deal. |
|
👍 no worries/rush. Just doing some new year tidying up |
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.
Fixes various warnings that the public API headers can trigger in client code, and does some tidying up along the way.
Shouldn't be any non-superficial changes.