doc-guide:kernel-doc.rst: Reference to foobar
[sfrench/cifs-2.6.git] / Documentation / doc-guide / kernel-doc.rst
index 8db53cdc225fc6add36c9dee9d971589e8911b95..51be62aa438548823c492e890f4d13b30d9d9347 100644 (file)
@@ -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.