diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-12-18 10:30:06 -0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-12-21 13:41:46 -0700 |
| commit | bdb76f9e305a45a7a1f0073a4b3a0fae9900bf97 (patch) | |
| tree | 7bcf3211600080b363096334f2553f851dad1ba6 | |
| parent | 553aa3c12e818a142e493a3d44a1eb8cadc2959f (diff) | |
| download | linux-stable-bdb76f9e305a45a7a1f0073a4b3a0fae9900bf97.tar.gz linux-stable-bdb76f9e305a45a7a1f0073a4b3a0fae9900bf97.tar.bz2 linux-stable-bdb76f9e305a45a7a1f0073a4b3a0fae9900bf97.zip | |
docs: kernel-doc.rst: improve typedef documentation
Add documentation about typedefs for function prototypes and
move it to happen earlier.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index e3e82f8f4de5..b178857866f8 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -282,6 +282,28 @@ The kernel-doc data structure comments describe each member of the structure, in order, with the member descriptions. +Typedef documentation +--------------------- + +The general format of a typedef kernel-doc comment is:: + + /** + * typedef type_name - Brief description. + * + * Description of the type. + */ + +Typedefs with function prototypes can also be documented:: + + /** + * typedef type_name - Brief description. + * @arg1: description of arg1 + * @arg2: description of arg2 + * + * Description of the type. + */ + typedef void (*type_name)(struct v4l2_ctrl *arg1, void *arg2); + Highlights and cross-references ------------------------------- @@ -384,16 +406,6 @@ on a line of their own, like all other kernel-doc comments:: int foobar; } -Typedef documentation ---------------------- - -The general format of a typedef kernel-doc comment is:: - - /** - * typedef type_name - Brief description. - * - * Description of the type. - */ Overview documentation comments ------------------------------- |