man: Doxygen docs fix 04 #518
Open
Conversation
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
…and add missing parameter tags
… add missing param tags in doxygen docstrings
…at/func2d.c for doxygen and IDEs
Since the UNUSED macros are placed after the parameter names, Doxygen parses the attribute (UNUSED) like if it was the parameter name, and the parameter name as if it was part of the type. Doxygen then can't find the correct parameter in the docstring, and complains that there's a parameter 'UNUSED' not documented, and that an extra parameter is documented but is missing in the function signature. This also applies to the NOPG_UNUSED and NO_NLS_UNUSED macros. In the Doxygen config, we can predefine macros with another definition, essentially removing them. Note that this also means that permalinks built from a has of the signatures will change, but they were wrong before.
github-actions
bot
added
libraries
module
database
raster
imagery
C
vector
raster3d
labels
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
lib/imagery/manage_signatures.c
Outdated
Comment on lines
236
to
237
| * \param out_list pointer to array of found signature strings or NULL if none found | ||
| * \return count of signature strings in the array |
There was a problem hiding this comment.
[clang-format] reported by reviewdog 🐶
Suggested change
| * \param out_list pointer to array of found signature strings or NULL if none found | |
| * \return count of signature strings in the array | |
| * \param out_list pointer to array of found signature strings or NULL if none | |
| * found \return count of signature strings in the array |
This reverts commit 9456f60.
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.
No description provided.