OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: update coding guideline for doxygen comments 

void-returning functions should not have '@return' tag documented as
required by doxygen 1.9.4 or later versions.

Tracked-On: #8425
Signed-off-by: Jiaqing Zhao <jiaqing.zhao@linux.intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Jiaqing Zhao 2023-06-08 04:30:10 +00:00 committed by David Kinder
parent 7bfbdf04b8
commit ab19b3e30d
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/developer-guides/c_coding_guidelines.rst
View File

@ -3312,8 +3312,7 @@ each function:
``@post <post-condition description>``. ``@post <post-condition description>``.
12) The brief description of the function return value shall be documented 12) The brief description of the function return value shall be documented
with the format ``@return <brief description of return value>``. with the format ``@return <brief description of return value>``.
13) A void-returning function shall be documented with the format 13) A void-returning function shall not be documented with ``@return``.
``@return None``.
14) The comments explaining the actual return values shall be documented with 14) The comments explaining the actual return values shall be documented with
the format ``@retval <return value> <return value explanation>``. the format ``@retval <return value> <return value explanation>``.
15) If the description of one element needs to span multiple lines, each line 15) If the description of one element needs to span multiple lines, each line