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

Documentation requirements #1

Open
hjunkes opened this issue Oct 18, 2018 · 2 comments
Open

Documentation requirements #1

hjunkes opened this issue Oct 18, 2018 · 2 comments

Comments

@hjunkes
Copy link
Contributor

hjunkes commented Oct 18, 2018

is there already a template how to document the header files with doxygen?

@anjohnson
Copy link
Member

Some of the yajl headers have doxygen markup in them (from the original author), although we might want to suggest a different set of conventions (both @ralphlange and @mdavidsaver seem to prefer @keyword instead of \keyword which is fine by me). I had a marked-up version of epicsExport.h which I had worked on some time back that I just created PR #2 with that which could serve as some kind of template, although that particular file only has macro definitions in it so it isn't a comprehensive example.

@ronaldomercado
Copy link
Contributor

I have been adding comments to @hjunkes 's pull request for postfix.h about the defgroup directive.
I think it is useful, because it adds entries under the Modules heading in the doxygen generated pages.
I am adding a group in the doxygen comments in resourceLib.h

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

No branches or pull requests

3 participants