diff options
| author |   Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2018-02-16 11:48:19 -0200 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2018-02-18 16:55:10 -0700 |
| commit | dbcce2bfb7766dbe5d3e293930cce57d0cd6badc (patch) | |
| tree | b936a33ff5a85f84d8c3e604780a882e932d10de /Documentation/doc-guide | |
| parent | scripts: kernel-doc: support in-line comments on nested structs/unions (diff) | |
| download | wireguard-linux-dbcce2bfb7766dbe5d3e293930cce57d0cd6badc.tar.xz wireguard-linux-dbcce2bfb7766dbe5d3e293930cce57d0cd6badc.zip | |
doc-guide: kernel-doc: add examples about nested union/structs
It helps to give some examples about how to use in-line
comments also when nested union/structs are present. So add it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 1ddfe35c0e78..c6c329708d8a 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -286,8 +286,17 @@ on a line of their own, like all other kernel-doc comments:: * Here, the member description may contain several paragraphs. */ int baz; - /** @foobar: Single line description. */ - int foobar; + union { + /** @foobar: Single line description. */ + int foobar; + }; + /** @bar2: Description for struct @bar2 inside @foo */ + struct { + /** + * @bar2.barbar: Description for @barbar inside @foo.bar2 + */ + int barbar; + } bar2; }; Typedef documentation |