diff options
| author | Igor Mammedov <imammedo@redhat.com> | 2017-10-04 12:08:00 +0200 |
|---|---|---|
| committer | Eduardo Habkost <ehabkost@redhat.com> | 2017-10-09 23:21:52 -0300 |
| commit | 31b93521924dddb22621f8dba27cdce802406eb3 (patch) | |
| tree | 593c3c1aa6bc21b76bcd8ca6f50612fcfb02da23 /include/qom/object.h | |
| parent | e5766d6ec7524345f4c0fa284c065b68c5e93049 (diff) | |
| download | qemu-31b93521924dddb22621f8dba27cdce802406eb3.tar.gz | |
qom: update doc comment for type_register[_static]()
type_register()/type_register_static() functions in current impl.
can't fail returning 0, also none of the users check for error
so update doc comment to reflect current behaviour.
Suggested-by: Eduardo Habkost <ehabkost@redhat.com>
Signed-off-by: Igor Mammedov <imammedo@redhat.com>
Message-Id: <1507111682-66171-2-git-send-email-imammedo@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Diffstat (limited to 'include/qom/object.h')
| -rw-r--r-- | include/qom/object.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/qom/object.h b/include/qom/object.h index e0d9824415..a707b67781 100644 --- a/include/qom/object.h +++ b/include/qom/object.h @@ -773,7 +773,7 @@ const char *object_get_typename(const Object *obj); * @info and all of the strings it points to should exist for the life time * that the type is registered. * - * Returns: 0 on failure, the new #Type on success. + * Returns: the new #Type. */ Type type_register_static(const TypeInfo *info); @@ -784,7 +784,7 @@ Type type_register_static(const TypeInfo *info); * Unlike type_register_static(), this call does not require @info or its * string members to continue to exist after the call returns. * - * Returns: 0 on failure, the new #Type on success. + * Returns: the new #Type. */ Type type_register(const TypeInfo *info); |