| /linux/Documentation/core-api/ |
| H A D | mm-api.rst | 8 .. kernel-doc:: arch/x86/include/asm/uaccess.h
11 .. kernel-doc:: arch/x86/lib/usercopy_32.c
14 .. kernel-doc:: mm/gup.c
22 .. kernel-doc:: include/linux/gfp_types.h
23 :doc: Page mobility and placement hints
25 .. kernel-doc:: include/linux/gfp_types.h
26 :doc: Watermark modifiers
28 .. kernel-doc:: include/linux/gfp_types.h
29 :doc: Reclaim modifiers
31 .. kernel-doc:: include/linux/gfp_types.h
[all …]
|
| H A D | kernel-api.rst | 9 .. kernel-doc:: include/linux/list.h
24 .. kernel-doc:: lib/vsprintf.c
27 .. kernel-doc:: include/linux/kstrtox.h
30 .. kernel-doc:: lib/kstrtox.c
33 .. kernel-doc:: lib/string_helpers.c
39 .. kernel-doc:: include/linux/fortify-string.h
42 .. kernel-doc:: lib/string.c
45 .. kernel-doc:: include/linux/string.h
48 .. kernel-doc:: mm/util.c
60 .. kernel-doc:: include/asm-generic/bitops/instrumented-atomic.h
[all …]
|
| /linux/Documentation/gpu/ |
| H A D | drm-kms-helpers.rst | 39 .. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
40 :doc: overview
42 .. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
53 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
54 :doc: overview
59 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
60 :doc: implementing nonblocking commit
65 .. kernel-doc:: include/drm/drm_atomic_helper.h
68 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
74 .. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
[all …]
|
| H A D | vga-switcheroo.rst | 7 .. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
8 :doc: Overview
16 .. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
17 :doc: Manual switching and manual power control
22 .. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
23 :doc: Driver power control
31 .. kernel-doc:: drivers/gpu/vga/vga_switcheroo.c
37 .. kernel-doc:: include/linux/vga_switcheroo.h
40 .. kernel-doc:: include/linux/vga_switcheroo.h
46 .. kernel-doc:: include/linux/vga_switcheroo.h
[all …]
|
| H A D | vc4.rst | 5 .. kernel-doc:: drivers/gpu/drm/vc4/vc4_drv.c
6 :doc: Broadcom VC4 Graphics Driver
18 .. kernel-doc:: drivers/gpu/drm/vc4/vc4_crtc.c
19 :doc: VC4 CRTC module
24 .. kernel-doc:: drivers/gpu/drm/vc4/vc4_hvs.c
25 :doc: VC4 HVS module.
30 .. kernel-doc:: drivers/gpu/drm/vc4/vc4_plane.c
31 :doc: VC4 plane module
36 .. kernel-doc:: drivers/gpu/drm/vc4/vc4_hdmi.c
37 :doc: VC4 Falcon HDMI module
[all …]
|
| H A D | drm-kms.rst | 156 .. kernel-doc:: include/drm/drm_mode_config.h
159 .. kernel-doc:: drivers/gpu/drm/drm_mode_config.c
188 .. kernel-doc:: include/drm/drm_mode_object.h
191 .. kernel-doc:: drivers/gpu/drm/drm_mode_object.c
288 .. kernel-doc:: drivers/gpu/drm/drm_atomic.c
289 :doc: handling driver private state
294 .. kernel-doc:: include/drm/drm_atomic.h
297 .. kernel-doc:: drivers/gpu/drm/drm_atomic.c
303 .. kernel-doc:: drivers/gpu/drm/drm_atomic_uapi.c
304 :doc: overview
[all …]
|
| H A D | v3d.rst | 5 .. kernel-doc:: drivers/gpu/drm/v3d/v3d_drv.c
6 :doc: Broadcom V3D Graphics Driver
11 .. kernel-doc:: drivers/gpu/drm/v3d/v3d_bo.c
12 :doc: V3D GEM BO management support
16 .. kernel-doc:: drivers/gpu/drm/v3d/v3d_mmu.c
17 :doc: Broadcom V3D MMU
21 .. kernel-doc:: drivers/gpu/drm/v3d/v3d_sched.c
22 :doc: Broadcom V3D scheduling
27 .. kernel-doc:: drivers/gpu/drm/v3d/v3d_irq.c
28 :doc: Interrupt management for the V3D engine
|
| H A D | meson.rst | 5 .. kernel-doc:: drivers/gpu/drm/meson/meson_drv.c
6 :doc: Video Processing Unit
30 .. kernel-doc:: drivers/gpu/drm/meson/meson_viu.c
31 :doc: Video Input Unit
36 .. kernel-doc:: drivers/gpu/drm/meson/meson_vpp.c
37 :doc: Video Post Processing
42 .. kernel-doc:: drivers/gpu/drm/meson/meson_venc.c
43 :doc: Video Encoder
48 .. kernel-doc:: drivers/gpu/drm/meson/meson_vclk.c
49 :doc: Video Clocks
[all …]
|
| /linux/Documentation/gpu/imagination/ |
| H A D | uapi.rst | 6 .. kernel-doc:: include/uapi/drm/pvr_drm.h
7 :doc: PowerVR UAPI
11 .. kernel-doc:: include/uapi/drm/pvr_drm.h
14 .. kernel-doc:: include/uapi/drm/pvr_drm.h
19 .. kernel-doc:: include/uapi/drm/pvr_drm.h
20 :doc: PowerVR IOCTL interface
22 .. kernel-doc:: include/uapi/drm/pvr_drm.h
27 .. kernel-doc:: include/uapi/drm/pvr_drm.h
28 :doc: PowerVR IOCTL DEV_QUERY interface
30 .. kernel-doc:: include/uapi/drm/pvr_drm.h
[all …]
|
| /linux/Documentation/sound/kernel-api/ |
| H A D | alsa-driver-api.rst | 10 .. kernel-doc:: sound/core/init.c
14 .. kernel-doc:: sound/core/device.c
18 .. kernel-doc:: sound/core/sound.c
22 .. kernel-doc:: sound/core/memory.c
23 .. kernel-doc:: sound/core/memalloc.c
31 .. kernel-doc:: sound/core/pcm.c
32 .. kernel-doc:: sound/core/pcm_lib.c
33 .. kernel-doc:: sound/core/pcm_native.c
34 .. kernel-doc:: include/sound/pcm.h
38 .. kernel-doc:: sound/core/pcm_misc.c
[all …]
|
| /linux/Documentation/gpu/amdgpu/ |
| H A D | driver-misc.rst | 14 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
15 :doc: product_name
20 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
21 :doc: product_number
26 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
27 :doc: serial_number
32 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
33 :doc: fru_id
38 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
39 :doc: manufacturer
[all …]
|
| /linux/drivers/mtd/nand/raw/ |
| H A D | diskonchip.c | 85 #define DoC_is_MillenniumPlus(doc) ((doc)->ChipID == DOC_ChipID_DocMilPlus16 || (doc)->ChipID == DO… argument
86 #define DoC_is_Millennium(doc) ((doc)->ChipID == DOC_ChipID_DocMil) argument
87 #define DoC_is_2000(doc) ((doc)->ChipID == DOC_ChipID_Doc2k) argument
217 static void DoC_Delay(struct doc_priv *doc, unsigned short cycles) in DoC_Delay() argument
223 if (DoC_is_Millennium(doc)) in DoC_Delay()
224 dummy = ReadDOC(doc->virtadr, NOP); in DoC_Delay()
225 else if (DoC_is_MillenniumPlus(doc)) in DoC_Delay()
226 dummy = ReadDOC(doc->virtadr, Mplus_NOP); in DoC_Delay()
228 dummy = ReadDOC(doc->virtadr, DOCStatus); in DoC_Delay()
236 static int _DoC_WaitReady(struct doc_priv *doc) in _DoC_WaitReady() argument
[all …]
|
| /linux/Documentation/driver-api/ |
| H A D | basics.rst | 7 .. kernel-doc:: include/linux/module.h
13 .. kernel-doc:: include/linux/mod_devicetable.h
21 .. kernel-doc:: include/linux/sched.h
24 .. kernel-doc:: kernel/sched/core.c
27 .. kernel-doc:: kernel/sched/cpupri.c
30 .. kernel-doc:: kernel/sched/fair.c
33 .. kernel-doc:: include/linux/completion.h
39 .. kernel-doc:: include/linux/jiffies.h
42 .. kernel-doc:: kernel/time/time.c
45 .. kernel-doc:: kernel/time/timer.c
[all …]
|
| H A D | infiniband.rst | 13 .. kernel-doc:: drivers/infiniband/core/iwpm_util.h
16 .. kernel-doc:: drivers/infiniband/core/cq.c
19 .. kernel-doc:: drivers/infiniband/core/cm.c
22 .. kernel-doc:: drivers/infiniband/core/rw.c
25 .. kernel-doc:: drivers/infiniband/core/device.c
28 .. kernel-doc:: drivers/infiniband/core/verbs.c
31 .. kernel-doc:: drivers/infiniband/core/packer.c
34 .. kernel-doc:: drivers/infiniband/core/sa_query.c
37 .. kernel-doc:: drivers/infiniband/core/ud_header.c
40 .. kernel-doc:: drivers/infiniband/core/umem.c
[all …]
|
| H A D | input.rst | 7 .. kernel-doc:: include/linux/input.h
10 .. kernel-doc:: drivers/input/input.c
13 .. kernel-doc:: drivers/input/ff-core.c
16 .. kernel-doc:: drivers/input/ff-memless.c
22 .. kernel-doc:: include/linux/input/mt.h
25 .. kernel-doc:: drivers/input/input-mt.c
31 .. kernel-doc:: include/linux/input/matrix_keypad.h
37 .. kernel-doc:: include/linux/input/sparse-keymap.h
40 .. kernel-doc:: drivers/input/sparse-keymap.c
45 .. kernel-doc:: include/linux/libps2.h
[all …]
|
| /linux/Documentation/translations/zh_CN/doc-guide/ |
| H A D | kernel-doc.rst | 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/general-information.rst 。
19 从注释中提取kernel-doc结构，并从中生成适当的 `Sphinx C 域`_ 函数和带有锚点的
20 类型描述。这些注释将被过滤以生成特殊kernel-doc高亮和交叉引用。详见下文。
22 .. _Sphinx C 域: http://www.sphinx-doc.org/en/stable/domains.html
25 应该有一个kernel-doc注释。模块使用的头文件中的函数和数据结构也应该有
[all …]
|
| /linux/Documentation/driver-api/80211/ |
| H A D | cfg80211.rst | 5 .. kernel-doc:: include/net/cfg80211.h
6 :doc: Introduction
11 .. kernel-doc:: include/net/cfg80211.h
12 :doc: Device registration
14 .. kernel-doc:: include/net/cfg80211.h
45 .. kernel-doc:: include/net/cfg80211.h
46 :doc: Actions and configuration
48 .. kernel-doc:: include/net/cfg80211.h
99 .. kernel-doc:: include/net/cfg80211.h
100 :doc: Scanning and BSS list handling
[all …]
|
| H A D | mac80211-advanced.rst | 17 .. kernel-doc:: include/net/mac80211.h
30 .. kernel-doc:: include/net/mac80211.h
31 :doc: Hardware crypto acceleration
33 .. kernel-doc:: include/net/mac80211.h
45 .. kernel-doc:: include/net/mac80211.h
46 :doc: Powersave support
51 .. kernel-doc:: include/net/mac80211.h
52 :doc: Beacon filter support
54 .. kernel-doc:: include/net/mac80211.h
62 .. kernel-doc:: include/net/mac80211.h
[all …]
|
| /linux/Documentation/driver-api/media/drivers/ |
| H A D | frontends.rst | 12 .. kernel-doc:: drivers/media/dvb-frontends/a8293.h
13 .. kernel-doc:: drivers/media/dvb-frontends/af9013.h
14 .. kernel-doc:: drivers/media/dvb-frontends/ascot2e.h
15 .. kernel-doc:: drivers/media/dvb-frontends/cxd2820r.h
16 .. kernel-doc:: drivers/media/dvb-frontends/drxk.h
17 .. kernel-doc:: drivers/media/dvb-frontends/dvb-pll.h
18 .. kernel-doc:: drivers/media/dvb-frontends/helene.h
19 .. kernel-doc:: drivers/media/dvb-frontends/horus3a.h
20 .. kernel-doc:: drivers/media/dvb-frontends/ix2505v.h
21 .. kernel-doc:: drivers/media/dvb-frontends/m88ds3103.h
[all …]
|
| /linux/Documentation/devicetree/ |
| H A D | kernel-api.rst | 11 .. kernel-doc:: drivers/of/base.c
14 .. kernel-doc:: include/linux/of.h
17 .. kernel-doc:: drivers/of/property.c
20 .. kernel-doc:: include/linux/of_graph.h
23 .. kernel-doc:: drivers/of/address.c
26 .. kernel-doc:: drivers/of/irq.c
29 .. kernel-doc:: drivers/of/fdt.c
35 .. kernel-doc:: include/linux/of_device.h
38 .. kernel-doc:: drivers/of/device.c
41 .. kernel-doc:: include/linux/of_platform.h
[all …]
|
| /linux/Documentation/crypto/ |
| H A D | api-skcipher.rst | 4 .. kernel-doc:: include/linux/crypto.h
5 :doc: Block Cipher Algorithm Definitions
7 .. kernel-doc:: include/linux/crypto.h
13 .. kernel-doc:: include/crypto/skcipher.h
14 :doc: Symmetric Key Cipher API
16 .. kernel-doc:: include/crypto/skcipher.h
22 .. kernel-doc:: include/crypto/skcipher.h
23 :doc: Symmetric Key Cipher Request Handle
25 .. kernel-doc:: include/crypto/skcipher.h
31 .. kernel-doc:: include/crypto/internal/cipher.h
[all …]
|
| H A D | api-digest.rst | 4 .. kernel-doc:: include/crypto/hash.h
5 :doc: Message Digest Algorithm Definitions
7 .. kernel-doc:: include/crypto/hash.h
13 .. kernel-doc:: include/crypto/hash.h
14 :doc: Asynchronous Message Digest API
16 .. kernel-doc:: include/crypto/hash.h
22 .. kernel-doc:: include/crypto/hash.h
23 :doc: Asynchronous Hash Request Handle
25 .. kernel-doc:: include/crypto/hash.h
31 .. kernel-doc:: include/crypto/hash.h
[all …]
|
| H A D | api-kpp.rst | 4 .. kernel-doc:: include/crypto/kpp.h
10 .. kernel-doc:: include/crypto/kpp.h
11 :doc: Generic Key-agreement Protocol Primitives API
13 .. kernel-doc:: include/crypto/kpp.h
19 .. kernel-doc:: include/crypto/kpp.h
25 .. kernel-doc:: include/crypto/ecdh.h
26 :doc: ECDH Helper Functions
28 .. kernel-doc:: include/crypto/ecdh.h
34 .. kernel-doc:: include/crypto/dh.h
35 :doc: DH Helper Functions
[all …]
|
| /linux/Documentation/driver-api/surface_aggregator/ |
| H A D | internal-api.rst | 14 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_parser.h
17 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_parser.c
20 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_msgb.h
23 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.h
26 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_packet_layer.c
33 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_request_layer.h
36 .. kernel-doc:: drivers/platform/surface/aggregator/ssh_request_layer.c
43 .. kernel-doc:: drivers/platform/surface/aggregator/controller.h
46 .. kernel-doc:: drivers/platform/surface/aggregator/controller.c
53 .. kernel-doc:: drivers/platform/surface/aggregator/bus.c
[all …]
|
| /linux/Documentation/driver-api/tty/ |
| H A D | tty_struct.rst | 17 .. kernel-doc:: drivers/tty/tty_io.c
23 .. kernel-doc:: drivers/tty/tty_io.c
29 .. kernel-doc:: include/linux/tty.h
32 .. kernel-doc:: drivers/tty/tty_io.c
38 .. kernel-doc:: drivers/tty/tty_io.c
44 .. kernel-doc:: drivers/tty/tty_io.c
50 .. kernel-doc:: drivers/tty/tty_io.c
56 .. kernel-doc:: drivers/tty/tty_io.c
62 .. kernel-doc:: drivers/tty/tty_io.c
68 .. kernel-doc:: drivers/tty/tty_io.c
[all …]
|