Skip to content
This repository has been archived by the owner on Sep 27, 2021. It is now read-only.

Doxygen: audit codebase to make documentation consistent #161

Open
rfairley opened this issue Jan 12, 2019 · 1 comment
Open

Doxygen: audit codebase to make documentation consistent #161

rfairley opened this issue Jan 12, 2019 · 1 comment

Comments

@rfairley
Copy link
Member

Describe the feature
This adds documentation as comments to functions, classes, namespaces, files, etc. throughout the code using doxygen macros.

Remove unit tests from documentation (as discussed today).

Relevant items from (#121):

Remove names after @file in Doxygen
Reason: Apparently we do not actually need any name after this tag, so we should just remove it using a script

Reason for request
Consistently document the codebase fully so it can be read nicely in the rendered documentation. Also allows us to "catch up" where

Timeline
Merge before next "release" in first week of Feb.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant