[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/17] qga/qapi-schema: Fix member documentation markup
From: |
Markus Armbruster |
Subject: |
[PULL 11/17] qga/qapi-schema: Fix member documentation markup |
Date: |
Fri, 28 Apr 2023 12:28:55 +0200 |
GuestDiskStatsInfo's member documentation is parsed as ordinary text
due to missing colons. The generated documentation shows these
members as "Not documented".
The fix is obvious: add the missing colons.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20230425064223.820979-12-armbru@redhat.com>
---
qga/qapi-schema.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index bb9bac0655..6a20eeb297 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1553,11 +1553,11 @@
##
# @GuestDiskStatsInfo:
#
-# @name disk name
+# @name: disk name
#
-# @major major device number of disk
+# @major: major device number of disk
#
-# @minor minor device number of disk
+# @minor: minor device number of disk
##
{ 'struct': 'GuestDiskStatsInfo',
'data': {'name': 'str',
--
2.39.2
- [PULL 03/17] qapi: Fix misspelled references, (continued)
- [PULL 03/17] qapi: Fix misspelled references, Markus Armbruster, 2023/04/28
- [PULL 01/17] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status, Markus Armbruster, 2023/04/28
- [PULL 15/17] qapi: Format since information the conventional way: (since X.Y), Markus Armbruster, 2023/04/28
- [PULL 05/17] qapi/block-core: Clean up after removal of dirty bitmap @status, Markus Armbruster, 2023/04/28
- [PULL 13/17] qapi: Replace ad hoc "since" documentation by member documentation, Markus Armbruster, 2023/04/28
- [PULL 16/17] qapi storage-daemon/qapi: Fix documentation section structure, Markus Armbruster, 2023/04/28
- [PULL 08/17] qapi: Delete largely misleading "Stability Considerations", Markus Armbruster, 2023/04/28
- [PULL 14/17] qapi: Fix misspelled section tags in doc comments, Markus Armbruster, 2023/04/28
- [PULL 07/17] qapi: Tidy up examples, Markus Armbruster, 2023/04/28
- [PULL 02/17] qga/qapi-schema: Fix a misspelled reference, Markus Armbruster, 2023/04/28
- [PULL 11/17] qga/qapi-schema: Fix member documentation markup,
Markus Armbruster <=
- [PULL 17/17] docs/devel/qapi-code-gen: Describe some doc markup pitfalls, Markus Armbruster, 2023/04/28
- [PULL 10/17] qapi: Fix unintended definition lists in documentation, Markus Armbruster, 2023/04/28
- Re: [PULL 00/17] QAPI patches patches for 2023-04-28, Richard Henderson, 2023/04/29