[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-trivial] [Qemu-devel] [PATCH 2/3] object.h: improve OBJECT/OBJ
Re: [Qemu-trivial] [Qemu-devel] [PATCH 2/3] object.h: improve OBJECT/OBJECT_CLASS doc
Thu, 12 Jan 2017 11:18:00 +0000
On 12 January 2017 at 10:46, Michael Tokarev <address@hidden> wrote:
> 12.12.2016 20:31, Marc-André Lureau wrote:
>> Signed-off-by: Marc-André Lureau <address@hidden>
>> include/qom/object.h | 6 +++---
>> 1 file changed, 3 insertions(+), 3 deletions(-)
>> diff --git a/include/qom/object.h b/include/qom/object.h
>> index c5e6fc1f5d..c5456db05d 100644
>> --- a/include/qom/object.h
>> +++ b/include/qom/object.h
>> @@ -467,7 +467,7 @@ struct TypeInfo
>> * OBJECT:
>> * @obj: A derivative of #Object
>> - * Converts an object to a #Object. Since all objects are #Objects,
>> + * Converts an object to a #Object. Since all objects are #Object,
>> * this function will always succeed.
> I'm not sure this is a good change. Yes the type name is "Object"
> (singular), but we refer to multiple objectS (plural), so... :)
> If we had some coloring, we'd wrote it like, eg, #<b>Object</b>s,
> with "s" being outside of the type name.
Mmm, but doc-comment parsers won't be able to figure out that
#Objects should refer to the #Object type. You could rephrase
as "Since every object is an #Object" to get around that.