[librsvg] docs: Assorted fixes and additions to reduce gtk-doc warnings



commit 794c95b26244ef995e9b8d6d475fc9149edeffe2
Author: Evan Nemerson <evan nemerson com>
Date:   Tue Jun 3 14:34:58 2014 -0700

    docs: Assorted fixes and additions to reduce gtk-doc warnings
    
    https://bugzilla.gnome.org/show_bug.cgi?id=731182

 rsvg-styles.c |    5 +++--
 rsvg.h        |   26 +++++++++++++++++++-------
 2 files changed, 22 insertions(+), 9 deletions(-)
---
diff --git a/rsvg-styles.c b/rsvg-styles.c
index c6e365b..89ef29a 100644
--- a/rsvg-styles.c
+++ b/rsvg-styles.c
@@ -1501,7 +1501,8 @@ rsvg_state_free_all (RsvgState * state)
 
 /**
  * rsvg_property_bag_new:
- * @atts:
+ * @atts: (array zero-terminated=1): list of alternating attributes
+ *   and values
  * 
  * The property bag will NOT copy the attributes and values. If you need
  * to store them for later, use rsvg_property_bag_dup().
@@ -1526,7 +1527,7 @@ rsvg_property_bag_new (const char **atts)
 
 /**
  * rsvg_property_bag_dup:
- * @bag:
+ * @bag: property bag to duplicate
  * 
  * Returns a copy of @bag that owns the attributes and values.
  * 
diff --git a/rsvg.h b/rsvg.h
index cd83ab6..ebcdb61 100644
--- a/rsvg.h
+++ b/rsvg.h
@@ -54,8 +54,9 @@ GType rsvg_handle_get_type (void);
 
 /**
  * RsvgError:
+ * @RSVG_ERROR_FAILED: the request failed
  *
- * An enumeration representing possible error domains
+ * An enumeration representing possible errors
  */
 typedef enum {
     RSVG_ERROR_FAILED
@@ -75,9 +76,16 @@ typedef struct _RsvgHandleClass RsvgHandleClass;
 typedef struct _RsvgDimensionData RsvgDimensionData;
 typedef struct _RsvgPositionData RsvgPositionData;
 
+/**
+ * RsvgHandleClass:
+ * @parent: parent class
+ *
+ * Class structure for #RsvgHandle
+ */
 struct _RsvgHandleClass {
     GObjectClass parent;
 
+    /*< private >*/
     gpointer _abi_padding[15];
 };
 
@@ -107,6 +115,9 @@ struct _RsvgDimensionData {
 
 /**
  * RsvgPositionData:
+ * @x: position on the x axis
+ * @y: position on the y axis
+ *
  * Position of an SVG fragment.
  */
 struct _RsvgPositionData {
@@ -141,6 +152,10 @@ gboolean rsvg_handle_has_sub (RsvgHandle * handle, const char *id);
 
 /* GIO APIs */
 
+/**
+ * RsvgHandleFlags:
+ * @RSVG_HANDLE_FLAGS_NONE: none
+ */
 typedef enum /*< flags >*/ 
 {
     RSVG_HANDLE_FLAGS_NONE        = 0
@@ -184,14 +199,11 @@ void rsvg_handle_free (RsvgHandle * handle);
 
 /**
  * RsvgSizeFunc:
- * @width: Pointer to where to set/store the width
- * @height: Pointer to where to set/store the height
- * @user_data: User data pointer
+ * @width: (out): the width of the SVG
+ * @height: (out): the height of the SVG
+ * @user_data: user data
  *
  * Function to let a user of the library specify the SVG's dimensions
- * @width: the ouput width the SVG should be
- * @height: the output height the SVG should be
- * @user_data: user data
  *
  * Deprecated: Set up a cairo matrix and use rsvg_handle_render_cairo() instead.
  */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]