Skip to content

doxygen style for algorithm properties #595

Closed

Description

@burlen

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

2_medium_priorityan issue that should be fixed, but is not critical to the next releasedocumentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions