diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-09-29 11:32:18 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-15 07:49:38 +0200 |
| commit | 2791f47d26d1e49a747a0a1aa2d694e6aab447ab (patch) | |
| tree | 9e9b648665bf469c216666bfdafbf27997836c4f /Documentation/doc-guide | |
| parent | docs: kerneldoc.py: append the name of the parsed doc file (diff) | |
| download | linux-2791f47d26d1e49a747a0a1aa2d694e6aab447ab.tar.xz linux-2791f47d26d1e49a747a0a1aa2d694e6aab447ab.zip | |
docs: kerneldoc.py: add support for kerneldoc -nosymbol
Currently, there's no way to exclude identifiers from
a kernel-doc markup. Add support for it.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 4fd86c21397b..52a87ab4c99f 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -490,6 +490,14 @@ identifiers: *[ function/type ...]* .. kernel-doc:: lib/idr.c :identifiers: +no-identifiers: *[ function/type ...]* + Exclude documentation for each *function* and *type* in *source*. + + Example:: + + .. kernel-doc:: lib/bitmap.c + :no-identifiers: bitmap_parselist + functions: *[ function/type ...]* This is an alias of the 'identifiers' directive and deprecated. |