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

Comments on class- and method-level #21

Closed

3 tasks

pjattke opened this issue May 14, 2020 · 0 comments

Labels

Contributor

pjattke commented May 14, 2020 •

edited

Loading

The header files are not all commented well yet:

Add comments to every class briefly describing the entity it represents. Make sure that the used format is supported by Doxygen (check in generated docs).
- Add a description of which attributes are mandatory/optional.
Add comments to every method except the ones that are overridden, already commented on the top-level, and do not implement a different behavior.

pjattke added the documentation label

pjattke self-assigned this

pjattke added the thesis_impl label

pjattke removed their assignment

AlexanderViand removed the thesis_impl label

AlexanderViand closed this as completed

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