Lines Matching refs:comments

1 Writing kernel-doc comments
5 comments in the kernel-doc format to describe the functions, types
12    comments. Please stick to the style described here.
14 The kernel-doc structure is extracted from the comments, and proper
24 to be used by modules should also have kernel-doc comments.
33 How to format kernel-doc comments
36 The opening comment mark ``/**`` is used for kernel-doc comments. The
37 ``kernel-doc`` tool will extract comments marked this way. The rest of
41 The function and type kernel-doc comments should be placed just before
44 overview kernel-doc comments may be placed anywhere at the top indentation
49 documentation comments. For example::
203 ``/*`` comment marker. They may optionally include comments between the
276 In-line member documentation comments
280 There are two styles, single-line comments where both the opening ``/**`` and
281 closing ``*/`` are on the same line, and multi-line comments where they are each
282 on a line of their own, like all other kernel-doc comments::
345 .. attention:: The below are **only** recognized within kernel-doc comments,
385   instead. This is mostly for legacy comments.
390 To cross-reference the functions and types defined in the kernel-doc comments
409 Overview documentation comments
412 To facilitate having source code and comments close together, you can include
413 kernel-doc documentation blocks that are free-form comments instead of being
438 Including kernel-doc comments
441 The documentation comments may be included in any of the reStructuredText
457   The *source-pattern* is useful when the kernel-doc comments have been placed
504 Without options, the kernel-doc directive includes all documentation comments
509 ``scripts/kernel-doc`` script to extract the documentation comments from the