docs: fix typos in Doxygen comments and error messages - #25
Open
Avicennasis wants to merge 1 commit into
Open
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
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
Fixes 7 verified typos across 3 files. Each was checked against current
mastercontent before editing.Doxygen tag errors (documentation rendering bugs)
:brief Get tag.->@brief Get tag.(colon instead of@, so the brief never renders)@Get request header->@brief Get request header(@Getis not a Doxygen command)default of http method is get method.->The default http method is the get method.(missing articles)Message-string typos - please review carefully, these change runtime strings
task is not allow NULL->task must not be NULLcorePoolSize is not allow 0->corePoolSize must not be 0BlockingQueue is not allow NULL->BlockingQueue must not be NULLdataDize=%zu->dataSize=%zuThe last four touch exception/log message text rather than comments. I grepped the repo (including
tests/) for these strings and found no test assertions that depend on them, but flagging it so maintainers can double-check.No functional/behavioural changes beyond the message wording above; no identifiers renamed.
Note: I deliberately left the project's existing
can not/Can notphrasing untouched throughout, since it is used consistently across the codebase and in CONTRIBUTING.md, and appears to be house style rather than an error.