[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 3/5] qapi: Visitor documentation tweak
From: |
Eric Blake |
Subject: |
[Qemu-devel] [PATCH 3/5] qapi: Visitor documentation tweak |
Date: |
Fri, 14 Jul 2017 14:08:25 -0500 |
Make it clear that the name parameter to visit_start_struct()
has the same semantics as for visit_start_int().
Signed-off-by: Eric Blake <address@hidden>
---
include/qapi/visitor.h | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h
index b0a048f..dc09cc7 100644
--- a/include/qapi/visitor.h
+++ b/include/qapi/visitor.h
@@ -60,13 +60,13 @@
* visitors are declared here; the remaining visitors are generated in
* qapi-visit.h.
*
- * The @name parameter of visit_type_FOO() describes the relation
- * between this QAPI value and its parent container. When visiting
- * the root of a tree, @name is ignored; when visiting a member of an
- * object, @name is the key associated with the value; when visiting a
- * 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 @name parameter of visit_type_FOO() and visit_start_OBJECT()
+ * describes the relation between this QAPI value and its parent
+ * container. When visiting the root of a tree, @name is ignored;
+ * when visiting a member of an object, @name is the key associated
+ * with the value; when visiting a 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;
* they allocate address@hidden during input visits, leave it unchanged on
--
2.9.4
- [Qemu-devel] [PATCH 0/5] random qapi cleanups, Eric Blake, 2017/07/14
- [Qemu-devel] [PATCH 1/5] qapi: Further enhance visitor virtual walk doc example, Eric Blake, 2017/07/14
- [Qemu-devel] [PATCH 2/5] tests: Enhance qobject output to cover partial visit, Eric Blake, 2017/07/14
- [Qemu-devel] [PATCH 3/5] qapi: Visitor documentation tweak,
Eric Blake <=
- [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Eric Blake, 2017/07/14
- Re: [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Markus Armbruster, 2017/07/20
- Re: [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Eric Blake, 2017/07/20
- Re: [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Eric Blake, 2017/07/20
- Re: [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Markus Armbruster, 2017/07/21
- Re: [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Eric Blake, 2017/07/21
- Re: [Qemu-devel] [PATCH 5/5] qtest: Document calling conventions, Markus Armbruster, 2017/07/21
[Qemu-devel] [PATCH 4/5] qtest: Avoid passing raw strings through hmp(), Eric Blake, 2017/07/14