qom: Documentation addition for object_class_by_name()
authorPaolo Bonzini <pbonzini@redhat.com>
Wed, 2 May 2012 11:30:53 +0000 (13:30 +0200)
committerAndreas Färber <afaerber@suse.de>
Sat, 12 May 2012 12:17:52 +0000 (14:17 +0200)
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
[AF: Document the possible NULL return value]
Signed-off-by: Andreas Färber <afaerber@suse.de>
include/qemu/object.h

index ca1649c..d93b772 100644 (file)
@@ -555,6 +555,12 @@ ObjectClass *object_class_dynamic_cast(ObjectClass *klass,
  */
 const char *object_class_get_name(ObjectClass *klass);
 
+/**
+ * object_class_by_name:
+ * @typename: The QOM typename to obtain the class for.
+ *
+ * Returns: The class for @typename or %NULL if not found.
+ */
 ObjectClass *object_class_by_name(const char *typename);
 
 void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),