github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-12 12:30:08 +00:00
Code Issues Projects Releases Wiki Activity

doc: replace return with retval

Browse Source 
`@return` is dedicated for brief description of return values, not for comments
stating actual return values. In addition, sphinx + breathe does not join
multiple adjacent `@return`. This results in multiple `Return` sections in the
generated document, which is confusing.

This patch replaces `@return` with `@retval` for the lists of return
values. Adjacent `@retval` can be joined into one list by breathe.

v1 -> v2:

* Replace return value descriptions like `negative` and `positive` with
  expressions like `<0` and `>0` in `@retval`.
* Keep the list of `@retval` comprehensive, even when there is a `@return` to
  generally describe what the return value means.
* Drop duplicated `@return` when it does not give more information than the
  `@retval` list.

Tracked-On: #1595
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Junjie Mao
2018-11-21 17:28:28 +08:00
committed by Eddie Dong
parent 97eb72a4a0
commit 584f6b7255
14 changed files with 82 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
devicemodel/include/dm_string.h
View File

@@ -16,8 +16,8 @@
* @param base Base: 8, 10, 16...
* @param val Long integer convert from string.
*
* @return -1 error.
* @return 0 no error.
* @retval -1 error.
* @retval 0 no error.
*/
int dm_strtol(const char *s, char **end, unsigned int base, long *val);
@@ -30,8 +30,8 @@ int dm_strtol(const char *s, char **end, unsigned int base, long *val);
* @param base Base: 8, 10, 16...
* @param val Integer convert from string.
*
* @return -1 error.
* @return 0 no error.
* @retval -1 error.
* @retval 0 no error.
*/
int dm_strtoi(const char *s, char **end, unsigned int base, int *val);
@@ -44,8 +44,8 @@ int dm_strtoi(const char *s, char **end, unsigned int base, int *val);
* @param base Base: 8, 10, 16...
* @param val Unsigned long integer convert from string.
*
* @return -1 error.
* @return 0 no error.
* @retval -1 error.
* @retval 0 no error.
*/
int dm_strtoul(const char *s, char **end, unsigned int base, unsigned long *val);
@@ -58,8 +58,8 @@ int dm_strtoul(const char *s, char **end, unsigned int base, unsigned long *val)
* @param base Base: 8, 10, 16...
* @param val Unsigned integer convert from string.
*
* @return -1 error.
* @return 0 no error.
* @retval -1 error.
* @retval 0 no error.
*/
int dm_strtoui(const char *s, char **end, unsigned int base, unsigned int *val);