docs: add Doxygen comments #204
Open
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
vmaskmovps
force-pushed
the
feat/improve-docs
branch
from
f0d5f1c
to
f81b939
Compare
vmaskmovps
commented
Jun 18, 2024
| * @param s The string to check. | ||
| * @param pos The position of the character in the string. | ||
| * @return true if the character is a backslash, false otherwise. | ||
| */ | ||
| static bool __pattern_isSlash(const std::string &s, size_t pos) { |
There was a problem hiding this comment.
Sidenote: why aren't these defined as private methods on the pattern class?
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.
I was frustrated with the lack of documentation in parts of this library, so I decided to at least attempt to document every metod, field and class/struct I could.
The reason this PR is so big is because I went through everything (and added about 2300 lines in the process :P).
Please look through it (and especially at the end at opt, I am a bit unsure there). @MikeMirzayanov