motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-06 01:03:55 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Indent tagged doc comment sections properly

Browse source 
docs/devel/qapi-code-gen demands that the "second and subsequent lines
of sections other than "Example"/"Examples" should be indented".
Commit a937b6aa739q (qapi: Reformat doc comments to conform to current
conventions) missed a few instances, and messed up a few others.
Clean that up.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-5-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-05 08:46:58 +01:00
parent d988487882
commit 1ed1d4d608
5 changed files with 42 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

10
tests/qapi-schema/doc-good.json
View file

@ -73,8 +73,8 @@
# @Base:
#
# @base1:
# description starts on a new line,
# not indented
# description starts on a new line,
# minimally indented
##
{ 'struct': 'Base', 'data': { 'base1': 'Enum' },
'if': { 'all': ['IFALL1', 'IFALL2'] } }
@ -155,10 +155,10 @@
# TODO: frobnicate
# Notes:
#
# - Lorem ipsum dolor sit amet
# - Ut enim ad minim veniam
# - Lorem ipsum dolor sit amet
# - Ut enim ad minim veniam
#
# Duis aute irure dolor
# Duis aute irure dolor
# Example:
#
# -> in

2
tests/qapi-schema/doc-good.out
View file

@ -118,7 +118,7 @@ doc symbol=Base
arg=base1
description starts on a new line,
not indented
minimally indented
doc symbol=Variant1
body=
A paragraph