diff options
| author | Akira Yokosawa <akiyks@gmail.com> | 2022-06-09 15:28:40 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2022-06-28 00:24:40 +0200 |
| commit | 5372de4e4545dead978c53d9c03b7aee12d0f94d (patch) | |
| tree | 93e7cf7049ab1dc54c54c89cd80eb037bd054cf2 /Documentation/doc-guide/kernel-doc.rst | |
| parent | docs/doc-guide: Add footnote on Inkscape for better images in PDF documents (diff) | |
| download | linux-5372de4e4545dead978c53d9c03b7aee12d0f94d.tar.xz linux-5372de4e4545dead978c53d9c03b7aee12d0f94d.zip | |
docs/doc-guide: Put meta title for kernel-doc HTML page
kernel-doc.rst has two 1st level section titles of "Writing
kernel-doc comments" and "Including kernel-doc comments".
Therefore, rather than using the first one, put a meta title
of "Kernel-doc comments" for the title of the resulting HTML
page by using the "title" directive.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/15636c13-7fa2-f973-6d3d-361222b839ef@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide/kernel-doc.rst')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index a7cb2afd7990..9c779bd7a751 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -1,3 +1,5 @@ +.. title:: Kernel-doc comments + =========================== Writing kernel-doc comments =========================== |