-
Notifications
You must be signed in to change notification settings - Fork 109
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 Updates #853
Doxygen Updates #853
Conversation
@gspetro-NOAA said this is a good solution: #835 (comment) Will merge. |
A better solution would be to improve the users guides so they are actually useful, as has been done on other NCEPLIBS. The doxygen documentation is intended to be programmer documentation, not user documentation. In other words, it should be more detailed, more complete, and allow programmers to continue to document the code in a complete way. The answer should not be to just rename and ignore the problem, but instead to improve the documentation and ensure that programmers keep it up to date. This is what other NCEPLIBS projects are doing. |
DESCRIPTION OF CHANGES:
Each program has a 'user_guide' file in the ./docs directory for use in creating the doxygen. As viewed from Github, some of the links in these files don't point to anything. This can be confusing to community users who think these 'user_guide' files are finalized documentation. Per discussions with EPIC, rename these 'user_guide' files to discourage users from reading them from Github and include a readme file in the same directory pointing users to the actual documentation.
TESTS CONDUCTED:
The Doxygen files were created, pushed to rzdm for viewing, and looked correct.
DEPENDENCIES:
None.
DOCUMENTATION:
Doxygen was generated without warnings and viewed on rzdm for correctness.
ISSUE:
Fixes #835.