Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Mauro Carvalho Chehab
and committed by
Jonathan Corbet
333f602e
33220c1f
+112
+1
Documentation/tools/index.rst
+1
Documentation/tools/index.rst
+12
Documentation/tools/kdoc.rst
+12
Documentation/tools/kdoc.rst
+46
Documentation/tools/kdoc_ancillary.rst
+46
Documentation/tools/kdoc_ancillary.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
=================
4
+
Ancillary classes
5
+
=================
6
+
7
+
Argparse formatter class
8
+
========================
9
+
10
+
.. automodule:: lib.python.kdoc.enrich_formatter
11
+
:members:
12
+
:show-inheritance:
13
+
:undoc-members:
14
+
15
+
Regular expression class handler
16
+
================================
17
+
18
+
.. automodule:: lib.python.kdoc.kdoc_re
19
+
:members:
20
+
:show-inheritance:
21
+
:undoc-members:
22
+
23
+
24
+
Chinese, Japanese and Korean variable fonts handler
25
+
===================================================
26
+
27
+
.. automodule:: lib.python.kdoc.latex_fonts
28
+
:members:
29
+
:show-inheritance:
30
+
:undoc-members:
31
+
32
+
Kernel C file include logic
33
+
===========================
34
+
35
+
.. automodule:: lib.python.kdoc.parse_data_structs
36
+
:members:
37
+
:show-inheritance:
38
+
:undoc-members:
39
+
40
+
Python version ancillary methods
41
+
================================
42
+
43
+
.. automodule:: lib.python.kdoc.python_version
44
+
:members:
45
+
:show-inheritance:
46
+
:undoc-members:
+14
Documentation/tools/kdoc_output.rst
+14
Documentation/tools/kdoc_output.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
=======================
4
+
Kernel-doc output stage
5
+
=======================
6
+
7
+
Output handler for man pages and ReST
8
+
=====================================
9
+
10
+
.. automodule:: lib.python.kdoc.kdoc_output
11
+
:members:
12
+
:show-inheritance:
13
+
:undoc-members:
14
+
+29
Documentation/tools/kdoc_parser.rst
+29
Documentation/tools/kdoc_parser.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
=======================
4
+
Kernel-doc parser stage
5
+
=======================
6
+
7
+
File handler classes
8
+
====================
9
+
10
+
.. automodule:: lib.python.kdoc.kdoc_files
11
+
:members:
12
+
:show-inheritance:
13
+
:undoc-members:
14
+
15
+
Parsed item data class
16
+
======================
17
+
18
+
.. automodule:: lib.python.kdoc.kdoc_item
19
+
:members:
20
+
:show-inheritance:
21
+
:undoc-members:
22
+
23
+
Parser classes and methods
24
+
==========================
25
+
26
+
.. automodule:: lib.python.kdoc.kdoc_parser
27
+
:members:
28
+
:show-inheritance:
29
+
:undoc-members: