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.

Sign up for GitHub

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

Jump to bottom

Make sure all comments are in single doxygen style. #25

Open

forGGe opened this issue Mar 26, 2015 · 0 comments

Labels

prio:low type:refactoring

Milestone

Basic documentation

Owner

forGGe commented Mar 26, 2015

All doxygen comments must have unified style, e.g.:

    ///
    /// \brief Constructs parser using device with source data.
    /// \param[in] filePath A file which contains records.
    ///
    TextFileParser(QIODevice *device);

Methods and classes without comments should be supplied with Doxygen placeholders.

forGGe added the type:enhancement label

forGGe added this to the Basic documentation milestone

forGGe added type:refactoring and removed type:enhancement labels

forGGe added the prio:low label

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