Date: Thu, 28 Mar 2024 15:22:28 +0000 (UTC) Message-ID: <765858276.420.1711639348781@web-3> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_419_1798838712.1711639348781" ------=_Part_419_1798838712.1711639348781 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Goals for this project:
See Coding Guidelines for d=
etails on the formatting of the function comments themselves. The fun=
ction comment should contain most or all of the comments for the function, =
so that the reader can understand what the function is doing, instead of ha=
ving comments spread throughout the function. Comments inline with th=
e code should be short and be used to point out some tricky bit of implemen=
tation detail that needs to be explained. For example:
/=
**
<=
/code>* Implements method_table::meth=
od_name() method for subsystem.
*
<=
/code>* Provide a description of the func=
tion here, including any details
&=
nbsp;* about the function that may be important. This includes inform=
ation
&=
nbsp;* about locks held by the caller or other requirements that the functi=
on
&=
nbsp;* has of the calling function and how \a var1 and \a var2 might be use=
d.
<=
/code>*
=
* \param[in] &nbs=
p; var1 description of this variable
 =
;
* \param[in] va=
r2 another description of a variable,
* &=
nbsp; wit=
h more detail than fits on one line
* \param[in,=
out] var3 this one is for both input and output
*
* \retval 0 =
success
 =
;
* \retval &nb=
sp; -EAGAIN need to call this function again
* \retval -ENOMEM error al=
locating some structure
 =
;
* \retval =
negative error number for other errors
 =
;
*/
"git blame path/to/file.c
" then c=
hat or call someone in Skype to discuss the code and get a good understandi=
ng of it to write a good comment. Failing that, write what you th=
ink the function is doing, and then add the original authors as inspec=
tors for the patch.=
"git blame path/to/file.c
" to see other developers who worked on the=
file if needed).