Lines Matching refs:doc
3 :Original: Documentation/doc-guide/kernel-doc.rst
7 编写kernel-doc注释
10 Linux内核源文件可以包含kernel-doc格式的结构化文档注释，用以描述代码的函数、
13 .. note:: 内核文档格式与javadoc、gtk-doc或Doxygen看似很相似，但由于历史原因，
14 实际有着明显的不同。内核源包含成千上万个kernel-doc注释。请坚持遵循
17 .. note:: kernel-doc无法包含Rust代码：请参考 Documentation/rust/docs.rst 。
19 从注释中提取kernel-doc结构，并从中生成适当的 `Sphinx C 域`_ 函数和带有锚点的
20 类型描述。这些注释将被过滤以生成特殊kernel-doc高亮和交叉引用。详见下文。
22 .. _Sphinx C 域: http://www.sphinx-doc.org/en/stable/domains.html
25 应该有一个kernel-doc注释。模块使用的头文件中的函数和数据结构也应该有
26 kernel-doc注释。
28 对于其他内核文件（未标记为 ``static`` ）中外部可见的函数，提供kernel-doc格式
29 的文档是一个很好的实践。我们也建议为私有（文件 ``static`` ）程序提供kernel-doc
33 如何格式化kernel-doc注释
36 kernel-doc注释用 ``/**`` 作为开始标记。 ``kernel-doc`` 工具将提取以这种方式
40 函数和类型的kernel-doc注释应该放在所描述的函数或类型之前，以便最大限度地提高
41 更改代码的人同时更改文档的可能性。概述kernel-doc注释可以放在最顶部的任何地方。
43 用详细模式和不生成实际输出来运行 ``kernel-doc`` 工具，可以验证文档注释的格式
46 scripts/kernel-doc -v -none drivers/foo/bar.c
55 函数和函数式宏的kernel-doc注释的一般格式是::
100 如果函数的参数数目可变，则需用kernel-doc格式对其进行描述::
152 结构体（struct）、共用体（union）、枚举（enum）类型kernel-doc注释的一般格式为::
289 Typedef的kernel-doc文档注释的一般格式为::
314 在kernel-doc注释的描述文本中可以识别以下特殊模式，并将其转换为正确的
317 .. attention:: 以下内容 **仅** 在kernel-doc注释中识别， **不会** 在普通的
332 若你需要使用在kernel-doc脚本或reStructuredText中有特殊含义的字符，则此功能
379 为了促进源代码和注释紧密联合，可以将kernel-doc文档块作为自由形式的注释，而
380 不是函数、结构、联合、枚举或typedef的绑定kernel-doc。例如，这可以用于解释
402 包含kernel-doc注释
405 文档注释可以被包含在任何使用专用kernel-doc Sphinx指令扩展的reStructuredText
408 kernel-doc指令的格式如下::
410 .. kernel-doc:: source
420 当kernel-doc注释被放置在头文件中，而 ``EXPORT_SYMBOL`` 和 ``EXPORT_SYMBOL_GPL``
425 .. kernel-doc:: lib/bitmap.c
428 .. kernel-doc:: include/net/mac80211.h
437 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
446 .. kernel-doc:: lib/bitmap.c
449 .. kernel-doc:: lib/idr.c
457 .. kernel-doc:: lib/bitmap.c
463 doc: *title*
470 .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c
471 :doc: High Definition Audio over HDMI and Display Port
473 如果没有选项，kernel-doc指令将包含源文件中的所有文档注释。
475 kernel-doc扩展包含在内核源代码树中，位于 ``Documentation/sphinx/kerneldoc.py`` 。
476 在内部，它使用 ``scripts/kernel-doc`` 脚本从源代码中提取文档注释。
480 如何使用kernel-doc生成手册（man）页
483 如果您只想使用kernel-doc生成手册页，可以从内核git树这样做::
485 $ scripts/kernel-doc -man \
492 $ scripts/kernel-doc -man \
496 $ scripts/kernel-doc -man \