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 all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

4

Documentation/doc-guide/kernel-doc.rst

View file