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

begin to add doxygenation to the code #208

Open
edwardhartnett opened this issue Jul 22, 2024 · 0 comments
Open

begin to add doxygenation to the code #208

edwardhartnett opened this issue Jul 22, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardhartnett
Copy link
Contributor

We will doxygenate the source code as we have done for many other EMC projects.

I will provide a sample and some training, and we will start to update as we touch the code in development or testing.

Testing can provide many opportunities for documentation improvement. @AlysonStahl-NOAA anything you learn from @webisu via meetings or other interactions should make it into the code base as documentation updates. For example, if you are testing some function, and have to ask a bunch of questions to figure it out, make sure that the answers make it into the docs.

We'll start this after the 3.4.0 release.

@edwardhartnett edwardhartnett added the documentation Improvements or additions to documentation label Jul 22, 2024
@edwardhartnett edwardhartnett self-assigned this Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

1 participant