github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-22 12:44:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

doc-guide: kernel-doc: document Returns: spelling

Browse Source 
scripts/kernel-doc accepts "Return:" or "Returns:" for describing the
return value of a function or function-like macro, so document this
alternative spelling and use it in an example.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Suggested-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240522224726.10498-1-rdunlap@infradead.org
This commit is contained in:
Randy Dunlap 2024-05-22 15:47:26 -07:00 committed by Jonathan Corbet
parent 1613e604df
commit 23a0bc2851
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/doc-guide/kernel-doc.rst
View File

@ -143,7 +143,7 @@ Return values
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
The return value, if any, should be described in a dedicated section The return value, if any, should be described in a dedicated section
named ``Return``. named ``Return`` (or ``Returns``).
.. note:: .. note::
@ -337,7 +337,7 @@ Typedefs with function prototypes can also be documented::
* Description of the type. * Description of the type.
* *
* Context: Locking context. * Context: Locking context.
* Return: Meaning of the return value. * Returns: Meaning of the return value.
*/ */
typedef void (*type_name)(struct v4l2_ctrl *arg1, void *arg2); typedef void (*type_name)(struct v4l2_ctrl *arg1, void *arg2);