Add more documentation and include doxyfile #46
Merged
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
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Merged
emersonknapp
approved these changes
Mar 2, 2020
thomas-moulard
approved these changes
Mar 2, 2020
There was a problem hiding this comment.
Could you make sure the style is consistent across all comments? I just selected two places, but there are probably more. See the coding style: https://google.github.io/styleguide/cppguide.html#Comments
|
This PR passes tests and has two approvals if someone would like to merge it (unless of course someone else has comments). |
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.
To help bring this package up to quality level 1, this PR includes additional doxygen comment blocks for public functionality. Also included is a doxyfile.
Signed-off-by: Stephen Brawner brawner@gmail.com