Skip to content
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.

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

Uniform comment structure throughout the codebase #58

Closed
ccarels opened this issue Sep 6, 2018 · 1 comment · Fixed by #141
Closed

Uniform comment structure throughout the codebase #58

ccarels opened this issue Sep 6, 2018 · 1 comment · Fixed by #141
Assignees

Comments

@ccarels
Copy link
Contributor

ccarels commented Sep 6, 2018

Description
A uniform consistent comment structure is needed throughout.

In order to make a start and to facilitate developers adding comments, empty templates can be added throughout the code, to be filled in with details as time goes on.

Outcome
A basic structure for making comments in the code.

To include methods and functions, as well as variables, and elsewhere as needed.

Comments should be Doxygen compatible.

Timeline
As soon as possible.

Interfaces
Will this feature result in a backwards-incompatible interface change: No.

Expected semantic version number increment category (Please indicate x.y.z): y.

Notes
N/A.

@ccarels ccarels self-assigned this Sep 6, 2018
@ccarels
Copy link
Contributor Author

ccarels commented Dec 4, 2018

Subsumed under cc_pipeline_interfaces.

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

Successfully merging a pull request may close this issue.

1 participant