Lines Matching refs:comments

1 .. title:: Kernel-doc comments
4 Writing kernel-doc comments
8 comments in the kernel-doc format to describe the functions, types
15    comments. Please stick to the style described here.
20 The kernel-doc structure is extracted from the comments, and proper
30 to be used by modules should also have kernel-doc comments.
39 How to format kernel-doc comments
42 The opening comment mark ``/**`` is used for kernel-doc comments. The
43 ``kernel-doc`` tool will extract comments marked this way. The rest of
47 The function and type kernel-doc comments should be placed just before
50 overview kernel-doc comments may be placed anywhere at the top indentation
55 documentation comments. For example::
209 ``/*`` comment marker. They may optionally include comments between the
282 In-line member documentation comments
286 There are two styles, single-line comments where both the opening ``/**`` and
287 closing ``*/`` are on the same line, and multi-line comments where they are each
288 on a line of their own, like all other kernel-doc comments::
351 .. attention:: The below are **only** recognized within kernel-doc comments,
391   instead. This is mostly for legacy comments.
397 defined in the kernel-doc comments from reStructuredText documents.
416 Overview documentation comments
419 To facilitate having source code and comments close together, you can include
420 kernel-doc documentation blocks that are free-form comments instead of being
446 Including kernel-doc comments
449 The documentation comments may be included in any of the reStructuredText
465   The *source-pattern* is useful when the kernel-doc comments have been placed
523 Without options, the kernel-doc directive includes all documentation comments
528 ``scripts/kernel-doc`` script to extract the documentation comments from the