linux/Documentation/doc-guide
Randy Dunlap 23a0bc2851 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
2024-05-30 13:35:07 -06:00
..
contributing.rst docs: doc-guide: mention 'make refcheckdocs' 2023-10-22 20:38:55 -06:00
hello.dot docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
index.rst Add a maintainer entry profile for documentation 2020-01-24 09:48:39 -07:00
kernel-doc.rst doc-guide: kernel-doc: document Returns: spelling 2024-05-30 13:35:07 -06:00
maintainer-profile.rst docs: add blurb about target audience to maintainer-profile 2024-01-30 13:16:46 -07:00
parse-headers.rst doc: fix spelling about ReStructured Text 2024-04-02 10:07:51 -06:00
sphinx.rst docs: drop the version constraints for sphinx and dependencies 2024-03-03 08:17:20 -07:00
svg_image.svg docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00