On Fri, Oct 30, 2020 at 2:03 PM Marc-André Lureau <
marcandre.lur...@gmail.com> wrote:

>
>
> On Fri, Oct 30, 2020 at 2:17 AM Eduardo Habkost <ehabk...@redhat.com>
> wrote:
>
>> The array property registration code is hard to follow.  Move the
>> two steps into separate functions that have clear
>> responsibilities.
>>
>> Signed-off-by: Eduardo Habkost <ehabk...@redhat.com>
>> ---
>> Cc: Paolo Bonzini <pbonz...@redhat.com>
>> Cc: "Daniel P. Berrangé" <berra...@redhat.com>
>> Cc: Eduardo Habkost <ehabk...@redhat.com>
>> Cc: qemu-devel@nongnu.org
>> ---
>>  hw/core/qdev-properties.c | 60 ++++++++++++++++++++++++++-------------
>>  1 file changed, 41 insertions(+), 19 deletions(-)
>>
>> diff --git a/hw/core/qdev-properties.c b/hw/core/qdev-properties.c
>> index 27c09255d7..1f06dfb5d5 100644
>> --- a/hw/core/qdev-properties.c
>> +++ b/hw/core/qdev-properties.c
>> @@ -588,6 +588,32 @@ typedef struct {
>>      ObjectPropertyRelease *release;
>>  } ArrayElementProperty;
>>
>> +/**
>> + * Create ArrayElementProperty based on array length property
>> + * @array_len_prop (which was previously defined using
>> DEFINE_PROP_ARRAY()).
>> + */
>>
>
> (some day we will have to clarify our API doc style, but not now ;)
>
>
Actually, I didn't realize but we do use kerneldoc in sphinx nowadays.

Peter, shouldn't you have updated CODING_STYLE.rst to say explicitly that
our C API should be documented with it?

How do we enforce or check the comment style across the code base, or
per-files (without necessarily including it in the generated manual/doc)?

thanks

-- 
Marc-André Lureau

Reply via email to