github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2026-01-13 11:33:58 +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

4
hypervisor/include/arch/x86/pgtable.h
View File

@@ -82,7 +82,7 @@
*
* @param[in] x The specified host-physical address
*
* @return void pointer - The host-virtual address
* @return The translated host-virtual address
*/
static inline void *hpa2hva(uint64_t x)
{
@@ -93,7 +93,7 @@ static inline void *hpa2hva(uint64_t x)
*
* @param[in] x The specified host-virtual address
*
* @return unsigned long integer - The host-physical address
* @return The translated host-physical address
*/
static inline uint64_t hva2hpa(void *x)
{