doxygen comments to character.h #42579
Merged
Conversation
This file contains 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
add doxygen formatted comments to some enum
anothersimulacrum
added
<Documentation>
testing to see how this output works: http://dev.narc.ro/cataclysm/doxygen/Effects_Stat_Dexterity.html
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.
Summary
SUMMARY: None
Purpose of change
See if I can improve the user friendliness of character header in such a manner that doxygen can read it
Describe the solution
Mostly take the existing doc and just format is slightly differently for doxygen. Add some doc where I can (avoiding stating the obvious).
Describe alternatives you've considered
Some of my comments might be close to stating what is obvious. Stating the obvious is counter-productive; it makes the code less user friendly.
I'm not yet capable enough to doxygenate the entire file. Hopefully piecemeal modifications aren't distracting. FWIW this concern is somewhat lessened because the comments weren't uniform to begin with.
Additional context
This PR isn't seeking to be comprehensive. My main goal is do no harm and not get in the way. Secondary goal is to modestly improve the readability of the code. Also hoping to learn more about how doxygen works and stumble upon something cool it can do.