github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-10-08 18:25:05 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix docs with broken links

Browse Source 
Fix links in documentation that have moved (e.g.,
clearlinux.org/documentation moved to docs.01.org/clearlinux/latest).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2020-03-18 13:32:45 -07:00
committed by deb-intel
parent e99ddf28c3
commit a086d72974
14 changed files with 26 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3218,20 +3218,20 @@ function:
6) A blank line shall separate different paragraphs. Inside each paragraph, a
blank line is not required to separate each element.
7) The brief description of the function shall be documented with the format
'@brief <brief description>'.
'\@brief <brief description>'.
8) No specific format is required for the detailed description of the function.
9) The description of the function parameter shall be documented with the format
'@param <parameter name> <parameter description>'.
10) The pre-condition of the function shall be documented with the format '@pre
'\@param <parameter name> <parameter description>'.
10) The pre-condition of the function shall be documented with the format '\@pre
<pre-condition description>'.
11) The post-condition of the function shall be documented with the format
'@post <post-condition description>'.
'\@post <post-condition description>'.
12) The brief description of the function return value shall be documented with
the format '@return <brief description of return value>'.
13) A void-returning function shall be documented with the format '@return
the format '\@return <brief description of return value>'.
13) A void-returning function shall be documented with the format '\@return
None'.
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
shall be aligned to the start of the description in the first line for that
element.