| /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 | liveupdate.rst | 8 .. kernel-doc:: kernel/liveupdate/luo_core.c
9 :doc: Live Update Orchestrator (LUO)
13 .. kernel-doc:: kernel/liveupdate/luo_session.c
14 :doc: LUO Sessions
18 .. kernel-doc:: kernel/liveupdate/luo_file.c
19 :doc: LUO File Descriptors
23 .. kernel-doc:: include/linux/kho/abi/luo.h
24 :doc: Live Update Orchestrator ABI
35 .. kernel-doc:: include/linux/liveupdate.h
37 .. kernel-doc:: include/linux/kho/abi/luo.h
[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/rust/syn/ |
| H A D | export.rs | 3 #[doc(hidden)]
5 #[doc(hidden)]
7 #[doc(hidden)]
9 #[doc(hidden)]
11 #[doc(hidden)]
13 #[doc(hidden)]
15 #[doc(hidden)]
17 #[doc(hidden)]
19 #[doc(hidden)]
21 #[doc(hidden)]
[all …]
|
| H A D | group.rs | 10 #[doc(hidden)]
12 #[doc(hidden)]
14 #[doc(hidden)]
19 #[doc(hidden)]
21 #[doc(hidden)]
23 #[doc(hidden)]
28 #[doc(hidden)]
30 #[doc(hidden)]
32 #[doc(hidden)]
38 #[doc(hidden)]
[all …]
|
| H A D | lib.rs | 254 #![doc(html_root_url = "https://docs.rs/syn/2.0.106")]
333 #[cfg_attr(docsrs, doc(cfg(any(feature = "full", feature = "derive"))))]
339 #[cfg_attr(docsrs, doc(cfg(feature = "parsing")))]
355 #[cfg_attr(docsrs, doc(cfg(any(feature = "full", feature = "derive"))))]
361 #[cfg_attr(docsrs, doc(cfg(feature = "derive")))]
372 #[cfg_attr(docsrs, doc(cfg(feature = "full")))]
375 #[cfg_attr(docsrs, doc(cfg(any(feature = "full", feature = "derive"))))]
381 #[cfg_attr(docsrs, doc(cfg(feature = "full")))]
390 #[cfg_attr(docsrs, doc(cfg(feature = "parsing")))]
396 #[cfg_attr(docsrs, doc(cfg(feature = "full")))]
[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 | infrastructure.rst | 7 .. kernel-doc:: include/linux/device.h
11 .. kernel-doc:: include/linux/device/bus.h
14 .. kernel-doc:: include/linux/device/class.h
17 .. kernel-doc:: include/linux/device/driver.h
23 .. kernel-doc:: drivers/base/init.c
26 .. kernel-doc:: include/linux/device/driver.h
29 .. kernel-doc:: drivers/base/driver.c
32 .. kernel-doc:: drivers/base/core.c
35 .. kernel-doc:: drivers/base/syscore.c
38 .. kernel-doc:: include/linux/device/class.h
[all …]
|
| /linux/Documentation/gpu/ |
| 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 …]
|
| /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/rust/syn/gen/ |
| H A D | eq.rs | 9 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
12 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
19 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
22 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
29 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
32 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
40 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
43 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
51 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
54 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
[all …]
|
| H A D | visit_mut.rs | 33 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
38 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
46 #[cfg_attr(docsrs, doc(cfg(feature = "full")))]
51 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
56 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
61 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
66 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
71 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
78 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
83 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
[all …]
|
| H A D | clone.rs | 8 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
18 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
30 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
44 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
56 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
68 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
71 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
78 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
90 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
101 #[cfg_attr(docsrs, doc(cfg(feature = "clone-impls")))]
[all …]
|
| H A D | fold.rs | 31 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
36 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
44 #[cfg_attr(docsrs, doc(cfg(feature = "full")))]
49 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
54 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
59 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
64 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
69 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
74 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
79 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
[all …]
|
| H A D | visit.rs | 32 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
37 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
45 #[cfg_attr(docsrs, doc(cfg(feature = "full")))]
50 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
55 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
60 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
65 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
70 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
75 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
80 #[cfg_attr(docsrs, doc(cfg(any(feature = "derive", feature = "full"))))]
[all …]
|
| H A D | hash.rs | 10 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
20 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
31 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
45 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
57 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
69 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
86 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
97 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
109 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
121 #[cfg_attr(docsrs, doc(cfg(feature = "extra-traits")))]
[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/rust/kernel/sync/atomic/ |
| H A D | internal.rs | 70 $(#[doc=$doc:expr])*
74 $(#[doc = $doc])*
79 $(#[doc=$doc:expr])*
84 $(#[doc = $doc])*
90 $(#[doc = $doc])*
95 $(#[doc=$doc:expr])*
99 $(#[doc = $doc])*
163 $(#[doc=$doc:expr])*
173 $(#[doc=$doc])*
|