| /qemu/tests/qapi-schema/ |
| H A D | meson.build | 57 'doc-bad-alternate-member.json',
58 'doc-bad-boxed-command-arg.json',
59 'doc-bad-command-arg.json',
60 'doc-bad-enum-member.json',
61 'doc-bad-event-arg.json',
62 'doc-bad-feature.json',
63 'doc-bad-indent.json',
64 'doc-bad-section.json',
65 'doc-bad-symbol.json',
66 'doc-bad-union-member.json',
[all …]
|
| H A D | doc-good.out | 11 module doc-good.json
56 doc freeform
59 doc freeform
62 doc freeform
105 doc symbol=Enum
118 doc symbol=Base
124 doc symbol=Variant1
137 doc symbol=Variant2
140 doc symbol=Object
145 doc symbol=Alternate
[all …]
|
| H A D | test-qapi.py | 114 for doc in schema.docs:
115 if doc.symbol:
116 print('doc symbol=%s' % doc.symbol)
118 print('doc freeform')
119 print(' body=\n%s' % doc.body.text)
120 for arg, section in doc.args.items():
122 for feat, section in doc.features.items():
124 for section in doc.sections:
|
| H A D | doc-undoc-feature.json | 1 # Doc comment must cover all features
7 # @doc: documented feature
9 { 'command': 'foo', 'features': ['undoc', 'doc'] }
|
| H A D | doc-missing.err | 1 doc-missing.json: In command 'undocumented':
2 doc-missing.json:5: documentation comment required
|
| H A D | doc-undoc-feature.err | 1 doc-undoc-feature.json: In command 'foo':
2 doc-undoc-feature.json:9: feature 'undoc' lacks documentation
|
| H A D | doc-bad-symbol.err | 1 doc-bad-symbol.json: In command 'foo':
2 doc-bad-symbol.json:6: documentation comment is for 'food'
|
| H A D | doc-good.rst | 5 .. qapi-doc:: tests/qapi-schema/doc-good.json
|
| /qemu/docs/sphinx/ |
| H A D | qapidoc_legacy.py | 12 qapidoc is a Sphinx extension that implements the qapi-doc directive
17 It implements one new rST directive, "qapi-doc::".
18 Each qapi-doc:: directive takes one argument, which is the
25 https://www.sphinx-doc.org/en/master/development/index.html
107 doc = ifcond.docgen()
108 if not doc:
110 doc = nodes.literal('', doc)
112 return [doc]
115 nodelist.append(doc)
151 def _nodes_for_members(self, doc, what, base=None, branches=None): argument
[all …]
|
| H A D | qapidoc.py | 12 qapidoc is a Sphinx extension that implements the qapi-doc directive
17 It implements one new rST directive, "qapi-doc::".
18 Each qapi-doc:: directive takes one argument, which is the
25 https://www.sphinx-doc.org/en/master/development/index.html
259 # without an explicit return statement in the doc block, and we
279 if ent.doc and ent.doc.since:
280 assert ent.doc.since.kind == QAPIDoc.Kind.SINCE
282 self.add_line(f":since: {ent.doc.since.text}", ent.doc.since.info)
285 doc = ent.ifcond.docgen()
288 self.add_line(f":ifcond: {doc}", ent.info)
[all …]
|
| H A D | kerneldoc.py | 51 """Extract kernel-doc comments from the specified file"""
55 'doc': directives.unchanged_required,
66 # Pass the version string to kernel-doc, as it needs to use a different
90 elif 'doc' in self.options:
91 cmd += ['-function', str(self.options.get('doc'))]
98 cmd += ['-no-doc-sections']
108 logger.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd)))
119 'kernel-doc \'%s\' failed with return code %d' %
122 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
147 logger.warning('kernel-doc \'%s\' processing failed with: %s' %
[all …]
|
| H A D | dbusdoc.py | 8 """dbus-doc is a Sphinx extension that provides documentation from D-Bus XML."""
152 doc = DBusDoc(self, dbusfile)
154 doc.add_interface(iface)
156 result = parse_generated_content(self.state, doc.result)
161 """Register dbus-doc directive with Sphinx"""
163 app.add_directive("dbus-doc", DBusDocDirective)
|
| H A D | fakedbusdoc.py | 8 """dbus-doc is a Sphinx extension that provides documentation from D-Bus XML."""
24 """Register a fake dbus-doc directive with Sphinx"""
25 app.add_directive("dbus-doc", FakeDBusDocDirective)
|
| /qemu/contrib/gitdm/ |
| H A D | filetypes.txt | 36 order build,interface,tests,code,documentation,devel-doc,blobs
88 filetype devel-doc ^readme.*$
89 filetype devel-doc ^changelog.*
90 filetype devel-doc ^hacking.*$
91 filetype devel-doc ^licen(s|c)e.*$
92 filetype devel-doc ^copying.*$
93 filetype devel-doc ^MAINTAINERS$
94 filetype devel-doc ^BSD-2-Clause$
95 filetype devel-doc ^BSD-3-Clause$
96 filetype devel-doc ^GPL-2.0$
[all …]
|
| /qemu/scripts/qapi/ |
| H A D | parser.py | 52 doc: Optional['QAPIDoc'] = None):
55 self.doc: Optional['QAPIDoc'] = doc
183 doc: Optional['QAPIDoc'] = None) -> None:
184 self.exprs.append(QAPIExpression(expr, info, doc))
187 def reject_expr_doc(doc: Optional['QAPIDoc']) -> None:
188 if doc and doc.symbol:
190 doc.info,
192 % doc.symbol)
233 if name == 'doc-required':
236 "pragma 'doc-required' must be boolean")
[all …]
|
| H A D | schema.py | 96 def connect_doc(self, doc: Optional[QAPIDoc] = None) -> None:
122 doc: Optional[QAPIDoc],
130 self.doc = doc
148 def connect_doc(self, doc: Optional[QAPIDoc] = None) -> None:
149 super().connect_doc(doc)
150 doc = doc or self.doc
151 if doc:
153 doc.connect_feature(f)
419 doc: Optional[QAPIDoc],
425 super().__init__(name, info, doc, ifcond, features)
[all …]
|
| /qemu/rust/hw/char/pl011/src/ |
| H A D | registers.rs | 16 #[doc(alias = "offset")]
24 #[doc(alias = "UARTDR")]
27 #[doc(alias = "UARTRSR")]
28 #[doc(alias = "UARTECR")]
33 #[doc(alias = "UARTFR")]
38 #[doc(alias = "UARTFBRD")]
41 #[doc(alias = "UARTILPR")]
46 #[doc(alias = "UARTIBRD")]
49 #[doc(alias = "UARTLCR_H")]
52 #[doc(alias = "UARTCR")]
[all …]
|
| /qemu/scripts/tracetool/format/ |
| H A D | __init__.py | 58 doc = module.__doc__
59 if doc is None:
60 doc = ""
61 doc = doc.strip().split("\n")[0]
64 res.append((name, doc))
|
| /qemu/docs/specs/ |
| H A D | pci-ids.rst | 53 ivshmem device (:doc:`ivshmem-spec`)
66 PCI serial port (16550A) adapter (:doc:`pci-serial`)
68 PCI Dual-port 16550A adapter (:doc:`pci-serial`)
70 PCI Quad-port 16550A adapter (:doc:`pci-serial`)
72 PCI test device (:doc:`pci-testdev`)
104 All these devices are documented in :doc:`index`.
|
| /qemu/scripts/tracetool/backend/ |
| H A D | __init__.py | 80 doc = module.__doc__
81 if doc is None:
82 doc = ""
83 doc = doc.strip().split("\n")[0]
86 res.append((name, doc))
|
| /qemu/docs/system/ |
| H A D | confidential-guest-support.rst | 40 * AMD Secure Encrypted Virtualization (SEV) (see :doc:`i386/amd-memory-encryption`)
41 * Intel Trust Domain Extension (TDX) (see :doc:`i386/tdx`)
43 * s390x Protected Virtualization (PV) (see :doc:`s390x/protvirt`)
|
| H A D | monitor.rst | 22 .. hxtool-doc:: hmp-commands.hx
24 .. hxtool-doc:: hmp-commands-info.hx
|
| /qemu/ |
| H A D | qemu.nsi | 166 SetOutPath "$INSTDIR\doc"
167 File /r "${BINDIR}\doc"
170 …t "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\doc\index.html" "" "$INSTDIR\doc\index…
218 RMDir /r "$INSTDIR\doc"
|
| /qemu/docs/devel/ |
| H A D | qapi-domain.rst | 6 <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
10 <https://www.sphinx-doc.org/en/master/usage/domains/python.html>`_
16 <https://www.sphinx-doc.org/en/master/usage/domains/index.html>`_
21 <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_
64 <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists>`_
66 <https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists>`_
352 <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`_
355 <https://www.sphinx-doc.org/en/master/usage/domains/python.html#cross-referencing-python-objects>`_.
358 <https://www.sphinx-doc.org/en/master/usage/referencing.html#role-any>`_
401 <https://www.sphinx-doc.org/en/master/usage/domains/python.html#target-specification>`_,
[all …]
|
| /qemu/docs/devel/testing/ |
| H A D | qtest.rst | 86 .. kernel-doc:: system/qtest.c
87 :doc: QTest Protocol
93 .. kernel-doc:: tests/qtest/libqtest.h
|