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

Feature doxygen #373

Merged
merged 2 commits into from
Feb 15, 2017
Merged

Feature doxygen #373

merged 2 commits into from
Feb 15, 2017

Conversation

economon
Copy link
Member

@economon economon commented Feb 9, 2017

This PR adds an updated doxyfile (thanks Gigi Martinelli!) and a logo directly to SU2/Common/doc. Doxygen is now set up to be run directly from that directory with

$ doxygen su2_doxyfile

and an html/ directory will be created with the output. The latest Doxygen docs for v5.0 have been generated and can be found here: http://su2.stanford.edu/doxygen/.

However, we have many warnings when running doxy, and we can do a lot more to improve the documentation. We should customize further the doxyfile, update the SU2/Common/doc/docmain.hpp, and clean / improve the doxy comments throughout the code. Any volunteers to help?

@hlkline
Copy link
Member

hlkline commented Feb 9, 2017

This looks great - I notice that there's a couple of things in the doxygen file in su2code/Documentation/Doxygen/Doxyfile that might be helpful here (setting project name, there may be other things). I wonder if these two files could be merged? Perhaps we should remove su2code/Documentation/Doxygen?

For potential volunteers: all the warnings I see right now seem to come from inputs/outputs not included in the comments description - correcting this should be relatively accessible to folks just getting started, and I'd also encourage anyone who has introduced a new function recently to check and see if the comment block above the function declaration in the .hpp file is filled in.
Other doxygen info: I recall that the last time I worked with doxygen, some warnings went away once graphviz was installed on my local machine.

Sorry that I can't commit 100% to volunteering for this right now; but I might chip away at things once in a while.

@economon
Copy link
Member Author

Any other comments here? Otherwise, this is a simple addition that we can put in right away, and folks can hack away on Doxygen whenever their heart desires.

Copy link
Member

@talbring talbring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doxygen update was overdue 👍 Thanks Tom. Thats also something we should keep an eye on in future pull requests.

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.

3 participants