Commit 23a0bc28 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet

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

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Suggested-by: default avatarDmitry Baryshkov <dmitry.baryshkov@linaro.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240522224726.10498-1-rdunlap@infradead.org
parent 1613e604
...@@ -143,7 +143,7 @@ Return values ...@@ -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:: ...@@ -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);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment