Add documentation for functions #5
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
@maherou Is this something that should be looked at? |
Member
|
@EdmundGoodman - Thank you for proposing these improvements. You mention in your comments that the changes involve comments only. This code base is not under active development so we don’t have time to rigorously test your proposed changes. Can you provide some output from the code you are submitting that confirms no change in behavior? While your changes appear to be comment-only via visual inspection, there are many changed lines. Thank you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR resolves #4 , by adding Doxygen-style documentation comments for all functions in the HPCCG mini-app. This makes it easier for newcomers to the codebase to quickly understand the code, whilst leaving the functional and performance characteristics of the mini-app completely unaffected.