diff options
| author | John Snow <jsnow@redhat.com> | 2024-07-16 22:13:08 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-07-17 10:20:53 +0200 |
| commit | 14b48aaab92de5962e8cdb563875fc6937ef916e (patch) | |
| tree | b04def230ba992ced3b783f5d5ac40b91b8923a1 /qapi/string-input-visitor.c | |
| parent | e597a73a8c561141f757b3b1ef13470ebdec5640 (diff) | |
| download | qemu-14b48aaab92de5962e8cdb563875fc6937ef916e.zip qemu-14b48aaab92de5962e8cdb563875fc6937ef916e.tar.gz qemu-14b48aaab92de5962e8cdb563875fc6937ef916e.tar.bz2 | |
qapi: convert "Example" sections without titles
Use the no-option form of ".. qmp-example::" to convert any Examples
that do not have any form of caption or explanation whatsoever. Note
that in a few cases, example sections are split into two or more
separate example blocks. This is only done stylistically to create a
delineation between two or more logically independent examples.
See commit-3: "docs/qapidoc: create qmp-example directive", for a
detailed explanation of this custom directive syntax.
See commit+3: "qapi: remove "Example" doc section" for a detailed
explanation of why.
Note: an empty "TODO" line was added to announce-self to keep the
example from floating up into the body; this will be addressed more
rigorously in the new qapidoc generator.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20240717021312.606116-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Markup fixed in one place]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi/string-input-visitor.c')
0 files changed, 0 insertions, 0 deletions