diff options
author | Joris Gutjahr <joris.gutjahr@gmail.com> | 2018-10-28 22:28:28 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2018-11-08 01:31:51 +0300 |
commit | 1bb37a35671cb3fea74c213220dbd3815344f673 (patch) | |
tree | fa7ac2c2a78933e44a8ab420c85984993d618a4b /Documentation/doc-guide | |
parent | cba8087d829ef76c474406a083a770255f027c6f (diff) | |
download | linux-1bb37a35671cb3fea74c213220dbd3815344f673.tar.xz |
doc-guide:kernel-doc.rst: Reference to foobar
In the Function documentation Section of kernel-doc.rst
there is a function_name() function as an example for
how to make a comment about a function.
But at the end of that example there is a reference to foobar
instead of function_name.
I think that should rather be function_name, because that
was the placeholder the whole example was using.
Signed-off-by: Joris Gutjahr <joris.gutjahr@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 8db53cdc225f..51be62aa4385 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -77,7 +77,7 @@ The general format of a function and function-like macro kernel-doc comment is:: * Context: Describes whether the function can sleep, what locks it takes, * releases, or expects to be held. It can extend over multiple * lines. - * Return: Describe the return value of foobar. + * Return: Describe the return value of function_name. * * The return value description can also have multiple paragraphs, and should * be placed at the end of the comment block. |