Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix up doxygen comments. #151

Merged
merged 3 commits into from Mar 9, 2019
Merged

Fix up doxygen comments. #151

merged 3 commits into from Mar 9, 2019

Conversation

dbaarda
Copy link
Member

@dbaarda dbaarda commented Mar 8, 2019

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 doc is now completely error and warning free.

dbaarda added 3 commits Mar 8, 2019
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.
@dbaarda dbaarda merged commit 4375539 into librsync:master Mar 9, 2019
1 check passed
@dbaarda dbaarda deleted the tidy/doxygen1 branch Mar 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant