mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qom: Explicitly tag doc comments for typedefs and structs

Browse Source 
If we explicitly indicate we are documenting a typedef or a
struct, we'll be able to remove the $decl_type='type name' hack
from kernel-doc.

Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20201003024123.193840-4-ehabkost@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
This commit is contained in:
Eduardo Habkost 2020-10-02 22:41:21 -04:00
parent 3cd3c5193c
commit ff59780f8d
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/qom/object.h
View File

@ -31,7 +31,7 @@ typedef struct InterfaceInfo InterfaceInfo;
typedef struct ObjectProperty ObjectProperty; typedef struct ObjectProperty ObjectProperty;
/** /**
* ObjectPropertyAccessor: * typedef ObjectPropertyAccessor:
* @obj: the object that owns the property * @obj: the object that owns the property
* @v: the visitor that contains the property data * @v: the visitor that contains the property data
* @name: the name of the property * @name: the name of the property
@ -47,7 +47,7 @@ typedef void (ObjectPropertyAccessor)(Object *obj,
Error **errp); Error **errp);
/** /**
* ObjectPropertyResolve: * typedef ObjectPropertyResolve:
* @obj: the object that owns the property * @obj: the object that owns the property
* @opaque: the opaque registered with the property * @opaque: the opaque registered with the property
* @part: the name of the property * @part: the name of the property
@ -66,7 +66,7 @@ typedef Object *(ObjectPropertyResolve)(Object *obj,
const char *part); const char *part);
/** /**
* ObjectPropertyRelease: * typedef ObjectPropertyRelease:
* @obj: the object that owns the property * @obj: the object that owns the property
* @name: the name of the property * @name: the name of the property
* @opaque: the opaque registered with the property * @opaque: the opaque registered with the property
@ -78,7 +78,7 @@ typedef void (ObjectPropertyRelease)(Object *obj,
void *opaque); void *opaque);
/** /**
* ObjectPropertyInit: * typedef ObjectPropertyInit:
* @obj: the object that owns the property * @obj: the object that owns the property
* @prop: the property to set * @prop: the property to set
* *
@ -101,7 +101,7 @@ struct ObjectProperty
}; };
/** /**
* ObjectUnparent: * typedef ObjectUnparent:
* @obj: the object that is being removed from the composition tree * @obj: the object that is being removed from the composition tree
* *
* Called when an object is being removed from the QOM composition tree. * Called when an object is being removed from the QOM composition tree.
@ -110,7 +110,7 @@ struct ObjectProperty
typedef void (ObjectUnparent)(Object *obj); typedef void (ObjectUnparent)(Object *obj);
/** /**
* ObjectFree: * typedef ObjectFree:
* @obj: the object being freed * @obj: the object being freed
* *
* Called when an object's last reference is removed. * Called when an object's last reference is removed.
@ -120,7 +120,7 @@ typedef void (ObjectFree)(void *obj);
#define OBJECT_CLASS_CAST_CACHE 4 #define OBJECT_CLASS_CAST_CACHE 4
/** /**
* ObjectClass: * struct ObjectClass:
* *
* The base for all classes. The only thing that #ObjectClass contains is an * The base for all classes. The only thing that #ObjectClass contains is an
* integer type handle. * integer type handle.
@ -140,7 +140,7 @@ struct ObjectClass
}; };
/** /**
* Object: * struct Object:
* *
* The base for all objects. The first member of this object is a pointer to * The base for all objects. The first member of this object is a pointer to
* a #ObjectClass. Since C guarantees that the first member of a structure * a #ObjectClass. Since C guarantees that the first member of a structure
@ -370,7 +370,7 @@ struct Object
true, { NULL }) true, { NULL })
/** /**
* TypeInfo: * struct TypeInfo:
* @name: The name of the type. * @name: The name of the type.
* @parent: The name of the parent type. * @parent: The name of the parent type.
* @instance_size: The size of the object (derivative of #Object). If * @instance_size: The size of the object (derivative of #Object). If
@ -496,7 +496,7 @@ struct TypeInfo
OBJECT_CLASS_CHECK(class, object_get_class(OBJECT(obj)), name) OBJECT_CLASS_CHECK(class, object_get_class(OBJECT(obj)), name)
/** /**
* InterfaceInfo: * struct InterfaceInfo:
* @type: The name of the interface. * @type: The name of the interface.
* *
* The information associated with an interface. * The information associated with an interface.
@ -506,7 +506,7 @@ struct InterfaceInfo {
}; };
/** /**
* InterfaceClass: * struct InterfaceClass:
* @parent_class: the base class * @parent_class: the base class
* *
* The class for all interfaces. Subclasses of this class should only add * The class for all interfaces. Subclasses of this class should only add