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

Doxygen output formatting & class documentation style guidelines #68

Open
jdeaton opened this issue Feb 7, 2020 · 0 comments
Open

Doxygen output formatting & class documentation style guidelines #68

jdeaton opened this issue Feb 7, 2020 · 0 comments
Assignees

Comments

@jdeaton
Copy link
Member

jdeaton commented Feb 7, 2020

One thing that would make the generated API documentation more readable is to move the "Detailed Description" to the top of the page. This can be done by providing a layout file (https://stackoverflow.com/questions/19831837/documenting-with-doxygen-put-details-on-top).

It would also be useful to provide some consistent guidelines for documenting all classes and work towards them.

@jdeaton jdeaton self-assigned this Feb 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant