Documentation/doc-guide/kernel-doc.rst

   1 Including kernel-doc comments
   2 =============================
   3
   4 The Linux kernel source files may contain structured documentation comments, or
   5 kernel-doc comments to describe the functions and types and design of the
   6 code. The documentation comments may be included to any of the reStructuredText
   7 documents using a dedicated kernel-doc Sphinx directive extension.
   8
   9 The kernel-doc directive is of the format::
  10
  11   .. kernel-doc:: source
  12      :option:
  13
  14 The *source* is the path to a source file, relative to the kernel source
  15 tree. The following directive options are supported:
  16
  17 export: *[source-pattern ...]*
  18   Include documentation for all functions in *source* that have been exported
  19   using ``EXPORT_SYMBOL`` or ``EXPORT_SYMBOL_GPL`` either in *source* or in any
  20   of the files specified by *source-pattern*.
  21
  22   The *source-pattern* is useful when the kernel-doc comments have been placed
  23   in header files, while ``EXPORT_SYMBOL`` and ``EXPORT_SYMBOL_GPL`` are next to
  24   the function definitions.
  25
  26   Examples::
  27
  28     .. kernel-doc:: lib/bitmap.c
  29        :export:
  30
  31     .. kernel-doc:: include/net/mac80211.h
  32        :export: net/mac80211/*.c
  33
  34 internal: *[source-pattern ...]*
  35   Include documentation for all functions and types in *source* that have
  36   **not** been exported using ``EXPORT_SYMBOL`` or ``EXPORT_SYMBOL_GPL`` either
  37   in *source* or in any of the files specified by *source-pattern*.
  38
  39   Example::
  40
  41     .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
  42        :internal:
  43
  44 doc: *title*
  45   Include documentation for the ``DOC:`` paragraph identified by *title* in
  46   *source*. Spaces are allowed in *title*; do not quote the *title*. The *title*
  47   is only used as an identifier for the paragraph, and is not included in the
  48   output. Please make sure to have an appropriate heading in the enclosing
  49   reStructuredText document.
  50
  51   Example::
  52
  53     .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
  54        :doc: High Definition Audio over HDMI and Display Port
  55
  56 functions: *function* *[...]*
  57   Include documentation for each *function* in *source*.
  58
  59   Example::
  60
  61     .. kernel-doc:: lib/bitmap.c
  62        :functions: bitmap_parselist bitmap_parselist_user
  63
  64 Without options, the kernel-doc directive includes all documentation comments
  65 from the source file.
  66
  67 The kernel-doc extension is included in the kernel source tree, at
  68 ``Documentation/sphinx/kernel-doc.py``. Internally, it uses the
  69 ``scripts/kernel-doc`` script to extract the documentation comments from the
  70 source.
  71
  72 .. _kernel_doc:
  73
  74 Writing kernel-doc comments
  75 ===========================
  76
  77 In order to provide embedded, "C" friendly, easy to maintain, but consistent and
  78 extractable overview, function and type documentation, the Linux kernel has
  79 adopted a consistent style for documentation comments. The format for this
  80 documentation is called the kernel-doc format, described below. This style
  81 embeds the documentation within the source files, using a few simple conventions
  82 for adding documentation paragraphs and documenting functions and their
  83 parameters, structures and unions and their members, enumerations, and typedefs.
  84
  85 .. note:: The kernel-doc format is deceptively similar to gtk-doc or Doxygen,
  86    yet distinctively different, for historical reasons. The kernel source
  87    contains tens of thousands of kernel-doc comments. Please stick to the style
  88    described here.
  89
  90 The ``scripts/kernel-doc`` script is used by the Sphinx kernel-doc extension in
  91 the documentation build to extract this embedded documentation into the various
  92 HTML, PDF, and other format documents.
  93
  94 In order to provide good documentation of kernel functions and data structures,
  95 please use the following conventions to format your kernel-doc comments in the
  96 Linux kernel source.
  97
  98 How to format kernel-doc comments
  99 ---------------------------------
 100
 101 The opening comment mark ``/**`` is reserved for kernel-doc comments. Only
 102 comments so marked will be considered by the ``kernel-doc`` tool. Use it only
 103 for comment blocks that contain kernel-doc formatted comments. The usual ``*/``
 104 should be used as the closing comment marker. The lines in between should be
 105 prefixed by `` * `` (space star space).
 106
 107 The function and type kernel-doc comments should be placed just before the
 108 function or type being described. The overview kernel-doc comments may be freely
 109 placed at the top indentation level.
 110
 111 Example kernel-doc function comment::
 112
 113   /**
 114    * foobar() - Brief description of foobar.
 115    * @arg: Description of argument of foobar.
 116    *
 117    * Longer description of foobar.
 118    *
 119    * Return: Description of return value of foobar.
 120    */
 121   int foobar(int arg)
 122
 123 The format is similar for documentation for structures, enums, paragraphs,
 124 etc. See the sections below for details.
 125
 126 The kernel-doc structure is extracted from the comments, and proper `Sphinx C
 127 Domain`_ function and type descriptions with anchors are generated for them. The
 128 descriptions are filtered for special kernel-doc highlights and
 129 cross-references. See below for details.
 130
 131 .. _Sphinx C Domain: http://www.sphinx-doc.org/en/stable/domains.html
 132
 133 Highlights and cross-references
 134 -------------------------------
 135
 136 The following special patterns are recognized in the kernel-doc comment
 137 descriptive text and converted to proper reStructuredText markup and `Sphinx C
 138 Domain`_ references.
 139
 140 .. attention:: The below are **only** recognized within kernel-doc comments,
 141                **not** within normal reStructuredText documents.
 142
 143 ``funcname()``
 144   Function reference.
 145
 146 ``@parameter``
 147   Name of a function parameter. (No cross-referencing, just formatting.)
 148
 149 ``%CONST``
 150   Name of a constant. (No cross-referencing, just formatting.)
 151
 152 ``$ENVVAR``
 153   Name of an environment variable. (No cross-referencing, just formatting.)
 154
 155 ``&struct name``
 156   Structure reference.
 157
 158 ``&enum name``
 159   Enum reference.
 160
 161 ``&typedef name``
 162   Typedef reference.
 163
 164 ``&struct_name->member`` or ``&struct_name.member``
 165   Structure or union member reference. The cross-reference will be to the struct
 166   or union definition, not the member directly.
 167
 168 ``&name``
 169   A generic type reference. Prefer using the full reference described above
 170   instead. This is mostly for legacy comments.
 171
 172 Cross-referencing from reStructuredText
 173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 174
 175 To cross-reference the functions and types defined in the kernel-doc comments
 176 from reStructuredText documents, please use the `Sphinx C Domain`_
 177 references. For example::
 178
 179   See function :c:func:`foo` and struct/union/enum/typedef :c:type:`bar`.
 180
 181 While the type reference works with just the type name, without the
 182 struct/union/enum/typedef part in front, you may want to use::
 183
 184   See :c:type:`struct foo <foo>`.
 185   See :c:type:`union bar <bar>`.
 186   See :c:type:`enum baz <baz>`.
 187   See :c:type:`typedef meh <meh>`.
 188
 189 This will produce prettier links, and is in line with how kernel-doc does the
 190 cross-references.
 191
 192 For further details, please refer to the `Sphinx C Domain`_ documentation.
 193
 194 Function documentation
 195 ----------------------
 196
 197 The general format of a function and function-like macro kernel-doc comment is::
 198
 199   /**
 200    * function_name() - Brief description of function.
 201    * @arg1: Describe the first argument.
 202    * @arg2: Describe the second argument.
 203    *        One can provide multiple line descriptions
 204    *        for arguments.
 205    *
 206    * A longer description, with more discussion of the function function_name()
 207    * that might be useful to those using or modifying it. Begins with an
 208    * empty comment line, and may include additional embedded empty
 209    * comment lines.
 210    *
 211    * The longer description may have multiple paragraphs.
 212    *
 213    * Return: Describe the return value of foobar.
 214    *
 215    * The return value description can also have multiple paragraphs, and should
 216    * be placed at the end of the comment block.
 217    */
 218
 219 The brief description following the function name may span multiple lines, and
 220 ends with an ``@argument:`` description, a blank comment line, or the end of the
 221 comment block.
 222
 223 The kernel-doc function comments describe each parameter to the function, in
 224 order, with the ``@argument:`` descriptions. The ``@argument:`` descriptions
 225 must begin on the very next line following the opening brief function
 226 description line, with no intervening blank comment lines. The ``@argument:``
 227 descriptions may span multiple lines. The continuation lines may contain
 228 indentation. If a function parameter is ``...`` (varargs), it should be listed
 229 in kernel-doc notation as: ``@...:``.
 230
 231 The return value, if any, should be described in a dedicated section at the end
 232 of the comment starting with "Return:".
 233
 234 Structure, union, and enumeration documentation
 235 -----------------------------------------------
 236
 237 The general format of a struct, union, and enum kernel-doc comment is::
 238
 239   /**
 240    * struct struct_name - Brief description.
 241    * @member_name: Description of member member_name.
 242    *
 243    * Description of the structure.
 244    */
 245
 246 Below, "struct" is used to mean structs, unions and enums, and "member" is used
 247 to mean struct and union members as well as enumerations in an enum.
 248
 249 The brief description following the structure name may span multiple lines, and
 250 ends with a ``@member:`` description, a blank comment line, or the end of the
 251 comment block.
 252
 253 The kernel-doc data structure comments describe each member of the structure, in
 254 order, with the ``@member:`` descriptions. The ``@member:`` descriptions must
 255 begin on the very next line following the opening brief function description
 256 line, with no intervening blank comment lines. The ``@member:`` descriptions may
 257 span multiple lines. The continuation lines may contain indentation.
 258
 259 In-line member documentation comments
 260 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 261
 262 The structure members may also be documented in-line within the definition.
 263 There are two styles, single-line comments where both the opening ``/**`` and
 264 closing ``*/`` are on the same line, and multi-line comments where they are each
 265 on a line of their own, like all other kernel-doc comments::
 266
 267   /**
 268    * struct foo - Brief description.
 269    * @foo: The Foo member.
 270    */
 271   struct foo {
 272         int foo;
 273         /**
 274          * @bar: The Bar member.
 275          */
 276         int bar;
 277         /**
 278          * @baz: The Baz member.
 279          *
 280          * Here, the member description may contain several paragraphs.
 281          */
 282         int baz;
 283         /** @foobar: Single line description. */
 284         int foobar;
 285   }
 286
 287 Private members
 288 ~~~~~~~~~~~~~~~
 289
 290 Inside a struct description, you can use the "private:" and "public:" comment
 291 tags. Structure fields that are inside a "private:" area are not listed in the
 292 generated output documentation.  The "private:" and "public:" tags must begin
 293 immediately following a ``/*`` comment marker.  They may optionally include
 294 comments between the ``:`` and the ending ``*/`` marker.
 295
 296 Example::
 297
 298   /**
 299    * struct my_struct - short description
 300    * @a: first member
 301    * @b: second member
 302    *
 303    * Longer description
 304    */
 305   struct my_struct {
 306       int a;
 307       int b;
 308   /* private: internal use only */
 309       int c;
 310   };
 311
 312
 313 Typedef documentation
 314 ---------------------
 315
 316 The general format of a typedef kernel-doc comment is::
 317
 318   /**
 319    * typedef type_name - Brief description.
 320    *
 321    * Description of the type.
 322    */
 323
 324 Overview documentation comments
 325 -------------------------------
 326
 327 To facilitate having source code and comments close together, you can include
 328 kernel-doc documentation blocks that are free-form comments instead of being
 329 kernel-doc for functions, structures, unions, enums, or typedefs. This could be
 330 used for something like a theory of operation for a driver or library code, for
 331 example.
 332
 333 This is done by using a ``DOC:`` section keyword with a section title.
 334
 335 The general format of an overview or high-level documentation comment is::
 336
 337   /**
 338    * DOC: Theory of Operation
 339    *
 340    * The whizbang foobar is a dilly of a gizmo. It can do whatever you
 341    * want it to do, at any time. It reads your mind. Here's how it works.
 342    *
 343    * foo bar splat
 344    *
 345    * The only drawback to this gizmo is that is can sometimes damage
 346    * hardware, software, or its subject(s).
 347    */
 348
 349 The title following ``DOC:`` acts as a heading within the source file, but also
 350 as an identifier for extracting the documentation comment. Thus, the title must
 351 be unique within the file.
 352
 353 Recommendations
 354 ---------------
 355
 356 We definitely need kernel-doc formatted documentation for functions that are
 357 exported to loadable modules using ``EXPORT_SYMBOL`` or ``EXPORT_SYMBOL_GPL``.
 358
 359 We also look to provide kernel-doc formatted documentation for functions
 360 externally visible to other kernel files (not marked "static").
 361
 362 We also recommend providing kernel-doc formatted documentation for private (file
 363 "static") routines, for consistency of kernel source code layout. But this is
 364 lower priority and at the discretion of the MAINTAINER of that kernel source
 365 file.
 366
 367 Data structures visible in kernel include files should also be documented using
 368 kernel-doc formatted comments.