pbio: additional documentation #153
Merged
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
Add doc comments for public members of the `parent` module.
This makes the function grouping also take effect in the generated docs.
This adds group names for functions for the tacho module. Also clean up includes and fix missing return type while we are touching this.
In pbio_tacho_reset_angle(), the angle parameter can act as either an input parameter or an output parameter depending on the value of reset_to_abs.
This applies the pattern of grouping public functions into 3 basic groups like in other modules.
Document undocumented functions in the trajectory module and also convert existing documentation comments to doxygen style.
Member
|
Thanks, this looks great! |
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.
This is filling in some gaps in the PBIO API documentation.