tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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

authored by

Randy Dunlap and committed by
Jonathan Corbet 23a0bc28 1613e604

+2 -2
+2 -2
Documentation/doc-guide/kernel-doc.rst
··· 143 143 ~~~~~~~~~~~~~ 144 144 145 145 The return value, if any, should be described in a dedicated section 146 - named ``Return``. 146 + named ``Return`` (or ``Returns``). 147 147 148 148 .. note:: 149 149 ··· 337 337 * Description of the type. 338 338 * 339 339 * Context: Locking context. 340 - * Return: Meaning of the return value. 340 + * Returns: Meaning of the return value. 341 341 */ 342 342 typedef void (*type_name)(struct v4l2_ctrl *arg1, void *arg2); 343 343