Convert comments to doxygen #76
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
|
I am fine with that. For one I learn a few techniques new to me, on the other hand it makes the documentation more useful for a wider audience. I envision a few merge conflicts with PR #75. Other than that there is no real trouble, since code is not affected, only documentation. |
wlammen
approved these changes
Mar 7, 2022
Surely the verb form of that should be "doxygenated"? 😁 |
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.
This will conflict with #75 to some extent, but I think it will be helpful for @wlammen to work from a base in which most functions are already (poorly) doxygen'd. In particular, the new doxygen comments should include or incorporate all of the text from the original documentation; there were some cases like
temp_vstringor the mmvstr.h header where sizable comments were ignored when the doxygen comment was added, resulting in two comments with different syntax and somewhat overlapping contents.