diff mbox

[v2,01/26] sysbus: document SysBusDeviceClass about @init

Message ID c571722db0c1cbf042965062045dba8c31fd9c2d.1372673778.git.hutao@cn.fujitsu.com
State New
Headers show

Commit Message

Hu Tao July 1, 2013, 10:18 a.m. UTC 
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
---
 include/hw/sysbus.h | 10 ++++++++++
 1 file changed, 10 insertions(+)
diff mbox

Patch

diff --git a/include/hw/sysbus.h b/include/hw/sysbus.h
index 7c2e316..9614758 100644
--- a/include/hw/sysbus.h
+++ b/include/hw/sysbus.h
@@ -23,6 +23,16 @@  typedef struct SysBusDevice SysBusDevice;
 #define SYS_BUS_DEVICE_GET_CLASS(obj) \
      OBJECT_GET_CLASS(SysBusDeviceClass, (obj), TYPE_SYS_BUS_DEVICE)
 
+/*
+ * SysBusDeviceClass:
+ * @parent_class: This is private
+ * @init: Callback function invoked when the #DeviceState::realized property
+ * is changed to %true. Deprecated, new types inheriting directly from
+ * TYPE_SYS_BUS_DEVICE should use #DeviceClass::realize instead, new leaf
+ * types should consult their respective parent type. SysBusDeviceClass is
+ * not implementing #DeviceClass::realize, so deriving classes can simply
+ * ignore it.
+ */
 typedef struct SysBusDeviceClass {
     DeviceClass parent_class;