Skip to content

261 doxygen formatting

Afonso Mukai requested to merge 261_doxygen_formatting into master

Created by: mchorazak

Description of work

Doxygen documentation uniformed:

  • \brief used (only) where it should be,

  • typos fixed,

  • public methods described in .h, private in .cpp,

  • Comments end with . now,

  • changed comments that are not "official enough" from /// to //,

  • fixed indentation and newlines in big blocks of comments to make them readable also within the source file,

  • removed some TODOs and created tickets for them.

Issue

Closes #261 (closed)

Acceptance Criteria

No functionality changed, just comments and doxygen files.

Unit Tests

N/A

Code Review (To be filled in by the reviewer only)

  • Is the code of an acceptable quality?
  • Do the changes function as described and is it robust?

Nominate for Group Code Review (Anyone can nominate it)

Indicate if you think the code should be reviewed in a Thursday code review session.

  • Recommend for group code review

Also, nominate it on the code_review Slack channel (does someone want to automate this?).

Merge request reports