Update developer guidelines with Doxygen instructions #99
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
pelesh
requested review from
abirchfield,
alexander-novo,
lukelowry,
reid-g and
nkoukpaizan
nkoukpaizan
approved these changes
May 7, 2025
CONTRIBUTING.md
Outdated
| two `*`. | ||
|
|
||
| ### Documenting functions | ||
| Functions should be documented in source files. The reationale is to have |
There was a problem hiding this comment.
reationale -> rationale
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
We use Doxygen markup to comment the code and produce developer documentation. We need a little bit more uniformity in how the code is commented and documented.
Proposed changes
Added section on Doxygen comments to the
CONTRIBUTING.mdfile with guidelines how to document the code. The documentation is meant for GridKit developers and it is separate from user documentation.Checklist
N/A
-Wall -Wpedantic -Wconversion -Wextra.Further comments
Additional suggestions how to expand the documentation are welcome.