Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Mauro Carvalho Chehab
and committed by
Jonathan Corbet
bdb76f9e
553aa3c1
+22
-10
+22
-10
Documentation/doc-guide/kernel-doc.rst
+22
-10
Documentation/doc-guide/kernel-doc.rst
···
282
282
in order, with the member descriptions.
283
283
284
284
285
+
Typedef documentation
286
+
---------------------
287
+
288
+
The general format of a typedef kernel-doc comment is::
289
+
290
+
/**
291
+
* typedef type_name - Brief description.
292
+
*
293
+
* Description of the type.
294
+
*/
295
+
296
+
Typedefs with function prototypes can also be documented::
297
+
298
+
/**
299
+
* typedef type_name - Brief description.
300
+
* @arg1: description of arg1
301
+
* @arg2: description of arg2
302
+
*
303
+
* Description of the type.
304
+
*/
305
+
typedef void (*type_name)(struct v4l2_ctrl *arg1, void *arg2);
306
+
285
307
286
308
Highlights and cross-references
287
309
-------------------------------
···
406
384
int foobar;
407
385
}
408
386
409
-
Typedef documentation
410
-
---------------------
411
-
412
-
The general format of a typedef kernel-doc comment is::
413
-
414
-
/**
415
-
* typedef type_name - Brief description.
416
-
*
417
-
* Description of the type.
418
-
*/
419
387
420
388
Overview documentation comments
421
389
-------------------------------