mirror of
https://github.com/qemu/qemu.git
synced 2025-08-15 05:06:56 +00:00
qapi: Document intended use of @name within alternate visits
Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <1493282486-28338-4-git-send-email-armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
This commit is contained in:
parent
6c02258e14
commit
ed0ba0f47e
@ -63,8 +63,10 @@
|
|||||||
* The @name parameter of visit_type_FOO() describes the relation
|
* The @name parameter of visit_type_FOO() describes the relation
|
||||||
* between this QAPI value and its parent container. When visiting
|
* between this QAPI value and its parent container. When visiting
|
||||||
* the root of a tree, @name is ignored; when visiting a member of an
|
* the root of a tree, @name is ignored; when visiting a member of an
|
||||||
* object, @name is the key associated with the value; and when
|
* object, @name is the key associated with the value; when visiting a
|
||||||
* visiting a member of a list, @name is NULL.
|
* member of a list, @name is NULL; and when visiting the member of an
|
||||||
|
* alternate, @name should equal the name used for visiting the
|
||||||
|
* alternate.
|
||||||
*
|
*
|
||||||
* The visit_type_FOO() functions expect a non-null @obj argument;
|
* The visit_type_FOO() functions expect a non-null @obj argument;
|
||||||
* they allocate *@obj during input visits, leave it unchanged on
|
* they allocate *@obj during input visits, leave it unchanged on
|
||||||
|
Loading…
Reference in New Issue
Block a user