summaryrefslogtreecommitdiff
path: root/Documentation/tools/kdoc_parser.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2026-01-19 17:23:18 +0100
committerJonathan Corbet <corbet@lwn.net>2026-01-23 11:37:38 -0700
commit333f602e2fb58b197769154682ac6f0acc7a08ea (patch)
tree9741b1496031b2e7ba0f0e8075911f328eeb2fbb /Documentation/tools/kdoc_parser.rst
parent33220c1fc10b2e53f0a79cdf6447fd7bf405a860 (diff)
downloadlinux-next-333f602e2fb58b197769154682ac6f0acc7a08ea.tar.gz
linux-next-333f602e2fb58b197769154682ac6f0acc7a08ea.zip
docs: add kernel-doc modules documentation
Place kernel-doc modules documentation at Linux Kernel docs. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <88ac2d82a45718c4e27aefac831586a71204ebf2.1768838938.git.mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/tools/kdoc_parser.rst')
-rw-r--r--Documentation/tools/kdoc_parser.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/Documentation/tools/kdoc_parser.rst b/Documentation/tools/kdoc_parser.rst
new file mode 100644
index 000000000000..03ee54a1b1cc
--- /dev/null
+++ b/Documentation/tools/kdoc_parser.rst
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=======================
+Kernel-doc parser stage
+=======================
+
+File handler classes
+====================
+
+.. automodule:: lib.python.kdoc.kdoc_files
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Parsed item data class
+======================
+
+.. automodule:: lib.python.kdoc.kdoc_item
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Parser classes and methods
+==========================
+
+.. automodule:: lib.python.kdoc.kdoc_parser
+ :members:
+ :show-inheritance:
+ :undoc-members: