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

Improvement of Doxycomments in the CCSDS FDP checksum class #2855

Merged
merged 4 commits into from
Sep 18, 2024

Conversation

JackNWhite
Copy link
Contributor

@JackNWhite JackNWhite commented Sep 2, 2024

Related Issue(s) n
Has Unit Tests (y/n) n
Documentation Included (y/n) y

Change Description

  • General improvement of the class Doxycomments, in particular those of the class itself and of the update() method.
  • Fixed/reinstated a broken link in the contributions readme.

Rationale

Usage of the class, particularly the update() method, was ambiguous and the existing comments were unclear.

Copy link
Collaborator

@LeStarch LeStarch left a 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.

CFDP/Checksum/Checksum.hpp Outdated Show resolved Hide resolved
Copy link
Collaborator

@thomas-bc thomas-bc left a 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!

@LeStarch
Copy link
Collaborator

LeStarch commented Sep 3, 2024

CI failure is being investigated.

@LeStarch
Copy link
Collaborator

Ignoring known CI failure.

@LeStarch LeStarch merged commit 3b6e3c5 into nasa:devel Sep 18, 2024
33 of 34 checks passed
@JackNWhite JackNWhite deleted the whitej/checksum_doxycomments branch September 19, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants