Add Doxygen-style file header comments to all .c and .h files#103
Open
Synergy738 wants to merge 3 commits intopabloosabaterr:mainfrom
Open
Add Doxygen-style file header comments to all .c and .h files#103Synergy738 wants to merge 3 commits intopabloosabaterr:mainfrom
Synergy738 wants to merge 3 commits intopabloosabaterr:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #94
What this PR does
Adds a consistent Doxygen-style header comment to the top of every
.cand.hfile in the project, as requested in issue #94.Format used
Each header follows the specified format:
@file— filename matching the actual file@brief— one-line summary of the module's purposeResponsibilities— bullet list of what the file ownsFiles changed
Added header comments to 24 files.