Files
acrn-hypervisor/devicemodel/include
Junjie Mao 584f6b7255 doc: replace return with retval
`@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>
2018-11-30 14:55:17 +08:00
..
2018-08-02 13:14:03 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-11-30 14:55:17 +08:00
2018-05-11 14:44:28 +08:00
2018-10-26 13:37:47 +08:00
2018-05-16 15:09:48 +08:00
2018-09-12 09:18:44 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-10-09 13:24:47 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-06-07 16:11:49 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-10-09 13:24:47 +08:00
2018-08-02 13:14:03 +08:00
2018-05-25 10:45:24 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-05-11 14:44:28 +08:00
2018-10-17 14:32:33 +08:00
2018-11-29 09:19:16 +08:00
2018-05-11 14:44:28 +08:00
2018-10-23 11:40:15 +08:00
2018-05-15 17:25:55 +08:00
2018-05-11 14:44:28 +08:00
2018-10-22 16:57:23 +08:00