include: zephyr: APIs doc: fix Doxygen \retval command usage #98324
+197
−197
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
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not be a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not be a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not be a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not be a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
Fix how Doxygen special commands \retval & \return are used in doc text. \retval: Starts a description for a function's return value with name <return value>, which needs to be attached and to not be a word that is part of the sentence, and each return val should have its own \retval. Otherwise \retval is replaced with \return. Signed-off-by: Abderrahmane JARMOUNI <[email protected]>
|
zephyrbot
requested review from
Thalley,
alwa-nordic,
andyross,
bjarki-andreasen,
dcpleung,
hermabe,
jhedberg,
jukkar,
nashif,
pdgendt,
peter-mitsis,
rlubos,
rugeGerritsen,
sjanc and
ssharks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fix how Doxygen special command \retval is used in APIs doc text.
\retval: Starts a description for a function's return value with name
<return value>, which needs to be attached and to not be a word that is part of the sentence, and each return value should have its own \retval.Otherwise \retval is replaced with \return.
See https://www.doxygen.nl/manual/commands.html#cmdreturn
https://www.doxygen.nl/manual/commands.html#cmdretval