Fix up doxygen comments. #151
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
For some reason doxygen commands like \file and \endcode in example code fragments break doxygen formatting. Swapped these for /file which might be a little missleading, but better than broken.
The \file structure commands should be on a line of their own, as now supported by the new version of tidyc. I also re-ran tidyc over everything. Remove other \typedef, \struct, etc doxygen structure commands which are not needed for comments immediately before the structure. Fix a few doxygen warnings about missing \param entries for some functions. Minor improvements to some doxygen comments. Running 'make doc' is now completely clean and warning free.
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 fixes some minor doxygen errors and warnings. The example generated docs can be seen at;
http://minkirri.apana.org.au/~abo/librsync
Running
make docis now completely error and warning free.