Documentation fixes #1994
Open
Documentation fixes #1994
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
Fixup documentation comments for functions with missing or extra parameters, or parameter name miss-matches with function definitions. Also fixes some misnamed directives (i.e. @doc -> @brief). Signed-off-by: Winford <[email protected]>
Fixes the misplaced module doc section, so that it appears at the top of the module where it should, rather than in the middle of the page. Signed-off-by: Winford <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 the supervisor module doc to appear at the top of the modules documentation, rather than further down the page.
Fixes several doxygen documentation sections where parameter names did not match the function definition, as well as missing or extra parameters. Fixed a few incorrect document directives (i.e.
@doc->@brief).These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later