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 style for algorithm properties #595

Closed
burlen opened this issue Apr 6, 2021 · 0 comments
Closed

doxygen style for algorithm properties #595

burlen opened this issue Apr 6, 2021 · 0 comments
Assignees
Labels
2_medium_priority an issue that should be fixed, but is not critical to the next release documentation

Comments

@burlen
Copy link
Collaborator

burlen commented Apr 6, 2021

The TECA_ALGORITHM_PROPERTY instantiations need to be converted to doxygen style. In the process run through a spell checker, fix capitalization, grammar, punctuation etc.

Here is an example:

    /** @anchor specific_humidity_variable
     * @name specific_humidity_variable
     * set the name of the variable that contains the specific humidity ("hus")
     */
    ///@{
    TECA_ALGORITHM_PROPERTY(std::string, specific_humidity_variable)
    ///@}

This was also discussed in #505

@burlen burlen added documentation 2_medium_priority an issue that should be fixed, but is not critical to the next release labels Apr 6, 2021
@burlen burlen closed this as completed Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2_medium_priority an issue that should be fixed, but is not critical to the next release documentation
Projects
None yet
Development

No branches or pull requests

2 participants