Re: [PATCH 04/17] qom: Change object_property_get_uint16List() to match its doc

[Eric Blake]

On 4/28/20 11:34 AM, Markus Armbruster wrote:
> Signed-off-by: Markus Armbruster <address@hidden>
> ---
>   include/qom/object.h       | 4 ++--
>   hw/core/machine-qmp-cmds.c | 6 +++---
>   qom/object.c               | 9 +++++----
>   3 files changed, 10 insertions(+), 9 deletions(-)
>
> diff --git a/include/qom/object.h b/include/qom/object.h
> index ccfa82e33d..5d1ed672c3 100644
> --- a/include/qom/object.h
> +++ b/include/qom/object.h
> @@ -1331,8 +1331,8 @@ int object_property_get_enum(Object *obj, const char 
> *name,

Adding context:

/**
 * object_property_get_uint16List:
 * @obj: the object
 * @name: the name of the property
 * @list: the returned int list
 * @errp: returns an error if this function fails
 *
 * Returns: the value of the property, converted to integers, or

>    * undefined if an error occurs (including when the property value is not
>    * an list of integers).
>    */
> -void object_property_get_uint16List(Object *obj, const char *name,
> -                                    uint16List **list, Error **errp);
> +uint16List *object_property_get_uint16List(Object *obj, const char *name,
> +                                           Error **errp);

Incomplete.  The doc comments need to drop the @list line, as well as 
s/undefined/#NULL/ in the Returns line.

With that fixed,
Reviewed-by: Eric Blake <address@hidden>

--
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org