[Qemu-devel] [PATCH 0/2] Some small documentation fixes

[Qemu-devel] [PATCH 0/2] Some small documentation fixes

[Andreas Färber]

Hey,

I've taken the liberty of rebasing Anthony's gtk-doc patches to verify the
documentation I'm adding in the CPU series. Here's some warning fixes that
came out of this endeavor.

Two open issues remain:
* Identifier extensions (e.g., #Objects) lead to warnings.
* Some structs are not picked up correctly, such as Object.

Regards,
Andreas

Cc: Anthony Liguori <anthony@codemonkey.ws>

Andreas Färber (2):
  qom: Fix typo in Object's documentation
  qom: Fix identifiers in documentation

 include/qemu/object.h |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

-- 
1.7.7

[Qemu-devel] [PATCH 1/2] qom: Fix typo in Object's documentation

[Andreas Färber]

Fixes a warning from gtk-doc.

Signed-off-by: Andreas Färber <afaerber@suse.de>
---
 include/qemu/object.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/include/qemu/object.h b/include/qemu/object.h
index 69cc2ab..c871254 100644
--- a/include/qemu/object.h
+++ b/include/qemu/object.h
@@ -330,7 +330,7 @@ struct TypeInfo
 
 /**
  * OBJECT_CLASS:
- * @class: A derivative of #ObjectClas.
+ * @class: A derivative of #ObjectClass.
  *
  * Converts a class to an #ObjectClass.  Since all objects are #Objects,
  * this function will always succeed.
-- 
1.7.7

[Qemu-devel] [PATCH 2/2] qom: Fix identifiers in documentation

[Andreas Färber]

Fixes gtk-doc warnings.

Signed-off-by: Andreas Färber <afaerber@suse.de>
---
 include/qemu/object.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/qemu/object.h b/include/qemu/object.h
index c871254..5179c0c 100644
--- a/include/qemu/object.h
+++ b/include/qemu/object.h
@@ -486,7 +486,7 @@ void object_finalize(void *obj);
 Object *object_dynamic_cast(Object *obj, const char *typename);
 
 /**
- * @object_dynamic_cast_assert:
+ * object_dynamic_cast_assert:
  *
  * See object_dynamic_cast() for a description of the parameters of this
  * function.  The only difference in behavior is that this function asserts
@@ -730,7 +730,7 @@ void object_property_set(Object *obj, struct Visitor *v, const char *name,
                          struct Error **errp);
 
 /**
- * @object_property_get_type:
+ * object_property_get_type:
  * @obj: the object
  * @name: the name of the property
  * @errp: returns an error if this function fails
-- 
1.7.7

Re: [Qemu-devel] [PATCH 0/2] Some small documentation fixes

[Anthony Liguori]

On 02/16/2012 11:03 AM, Andreas Färber wrote:
> Hey,
>
> I've taken the liberty of rebasing Anthony's gtk-doc patches to verify the
> documentation I'm adding in the CPU series. Here's some warning fixes that
> came out of this endeavor.
>
> Two open issues remain:
> * Identifier extensions (e.g., #Objects) lead to warnings.
> * Some structs are not picked up correctly, such as Object.

Applied all.  Thanks.

Regards,

Anthony Liguori

>
> Regards,
> Andreas
>
> Cc: Anthony Liguori<anthony@codemonkey.ws>
>
> Andreas Färber (2):
>    qom: Fix typo in Object's documentation
>    qom: Fix identifiers in documentation
>
>   include/qemu/object.h |    6 +++---
>   1 files changed, 3 insertions(+), 3 deletions(-)
>