Commit 23a0bc28 authored May 22, 2024 by Randy Dunlap Committed by Jonathan Corbet May 30, 2024

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: 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

parent 1613e604

Documentation/doc-guide/kernel-doc.rst

+2 −2

Original line number	Diff line number	Diff line
		@@ -143,7 +143,7 @@ Return values
		~~~~~~~~~~~~~

		The return value, if any, should be described in a dedicated section
		named ``Return``.
		named ``Return`` (or ``Returns``).

		.. note::

		@@ -337,7 +337,7 @@ Typedefs with function prototypes can also be documented::
		* Description of the type.
		*
		* 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);