diff options
author | Markus Armbruster <armbru@redhat.com> | 2019-08-02 14:23:25 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2019-09-24 11:03:44 +0200 |
commit | 81b49004e0846b3526e26c786b6f64d4f1a0e38a (patch) | |
tree | 41e4b4691f0dcd4c45c54889cd6e524a6a4cc5d1 | |
parent | 2f93a3ecdd3bb060bd04f698ccafe66efd98563a (diff) | |
download | qemu-81b49004e0846b3526e26c786b6f64d4f1a0e38a.zip qemu-81b49004e0846b3526e26c786b6f64d4f1a0e38a.tar.gz qemu-81b49004e0846b3526e26c786b6f64d4f1a0e38a.tar.bz2 |
qapi: Make visit_next_list()'s comment less confusing
visit_next_list() returns non-null on success, null on failure. The
comment's phrasing "until NULL return or error occurs" is needlessly
confusing. Scratch the "or error occurs" part.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20190802122325.16520-1-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
-rw-r--r-- | include/qapi/visitor.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h index 5b2ed3f..c5b2385 100644 --- a/include/qapi/visitor.h +++ b/include/qapi/visitor.h @@ -364,10 +364,10 @@ void visit_start_list(Visitor *v, const char *name, GenericList **list, * @tail must not be NULL; on the first call, @tail is the value of * *list after visit_start_list(), and on subsequent calls @tail must * be the previously returned value. Should be called in a loop until - * a NULL return or error occurs; for each non-NULL return, the caller - * then calls the appropriate visit_type_*() for the element type of - * the list, with that function's name parameter set to NULL and obj - * set to the address of @tail->value. + * a NULL return; for each non-NULL return, the caller then calls the + * appropriate visit_type_*() for the element type of the list, with + * that function's name parameter set to NULL and obj set to the + * address of @tail->value. */ GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size); |