mirror of
https://gitlab.com/qemu-project/qemu
synced 2024-10-15 07:22:46 +00:00
0cec50119f
The QAPI generator forces you to document your stuff. Except for command arguments, event data, and members of enum and object types: these the generator silently "documents" as "Not documented". We can't require proper documentation there without first fixing all the offenders. We've always had too many offenders to pull that off. Right now, we have more than 500. Worse, we seem to fix old ones no faster than we add new ones: in the past year, we fixed 22 ones, but added 26 new ones. To help arrest the backsliding, make missing documentation an error unless the command, type, or event is in listed in new pragma documentation-exceptions. List all the current offenders: 117 commands and types in qapi/, and 9 in qga/. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240205074709.3613229-7-armbru@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
12 lines
183 B
JSON
12 lines
183 B
JSON
# Arguments listed in the doc comment must exist in the actual schema
|
|
|
|
##
|
|
# @AorB:
|
|
# @a: a
|
|
# @b: b
|
|
# @aa: a
|
|
# @bb: b
|
|
##
|
|
{ 'alternate': 'AorB',
|
|
'data': { 'a': 'bool', 'b': 'int' } }
|