Skip to content

Commit

Permalink
qdev: Clean up around properties
Browse files Browse the repository at this point in the history
include:
1. remove unnecessary declaration of static function
2. fix inconsistency between comment and function name, and typo OOM->QOM
2. update comments of functions, use uniform format(GTK-Doc style)

Signed-off-by: Cao jin <caoj.fnst@cn.fujitsu.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
  • Loading branch information
Cao jin authored and Michael Tokarev committed Jun 7, 2016
1 parent 3b7c78c commit d9d8d45
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 13 deletions.
30 changes: 19 additions & 11 deletions hw/core/qdev.c
Expand Up @@ -58,9 +58,6 @@ const char *qdev_fw_name(DeviceState *dev)
return object_get_typename(OBJECT(dev));
}

static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
Error **errp);

static void bus_remove_child(BusState *bus, DeviceState *child)
{
BusChild *kid;
Expand Down Expand Up @@ -733,13 +730,20 @@ static void qdev_get_legacy_property(Object *obj, Visitor *v,
}

/**
* @qdev_add_legacy_property - adds a legacy property
* qdev_property_add_legacy:
* @dev: Device to add the property to.
* @prop: The qdev property definition.
* @errp: location to store error information.
*
* Add a legacy QOM property to @dev for qdev property @prop.
* On error, store error in @errp.
*
* Do not use this is new code! Properties added through this interface will
* be given names and types in the "legacy" namespace.
* Legacy properties are string versions of QOM properties. The format of
* the string depends on the property type. Legacy properties are only
* needed for "info qtree".
*
* Legacy properties are string versions of other OOM properties. The format
* of the string depends on the property type.
* Do not use this is new code! QOM Properties added through this interface
* will be given names in the "legacy" namespace.
*/
static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
Error **errp)
Expand All @@ -762,10 +766,14 @@ static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
}

/**
* @qdev_property_add_static - add a @Property to a device.
* qdev_property_add_static:
* @dev: Device to add the property to.
* @prop: The qdev property definition.
* @errp: location to store error information.
*
* Static properties access data in a struct. The actual type of the
* property and the field depends on the property type.
* Add a static QOM property to @dev for qdev property @prop.
* On error, store error in @errp. Static properties access data in a struct.
* The type of the QOM property is derived from prop->info.
*/
void qdev_property_add_static(DeviceState *dev, Property *prop,
Error **errp)
Expand Down
10 changes: 8 additions & 2 deletions include/hw/qdev-properties.h
Expand Up @@ -197,8 +197,14 @@ void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
Property *prop, const char *value);

/**
* @qdev_property_add_static - add a @Property to a device referencing a
* field in a struct.
* qdev_property_add_static:
* @dev: Device to add the property to.
* @prop: The qdev property definition.
* @errp: location to store error information.
*
* Add a static QOM property to @dev for qdev property @prop.
* On error, store error in @errp. Static properties access data in a struct.
* The type of the QOM property is derived from prop->info.
*/
void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp);

Expand Down

0 comments on commit d9d8d45

Please sign in to comment.