-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Improvement of Doxycomments in the CCSDS FDP checksum class #2855
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment about consistency for block comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just recently watched a talk about the power and importance of documentation so thank you very much for this!
CI failure is being investigated. |
…ecksum Doxycomments
Ignoring known CI failure. |
Change Description
update()
method.Rationale
Usage of the class, particularly the
update()
method, was ambiguous and the existing comments were unclear.