[librsvg] introspection: clean up lots of warnings emitted by g-ir-scanner



commit 5250092123e250d76b4bbbb8d518218d4c2ff032
Author: Evan Nemerson <evan coeus-group com>
Date:   Tue Jun 12 16:47:36 2012 -0700

    introspection: clean up lots of warnings emitted by g-ir-scanner

 rsvg-base.c         |   18 +++++++++---------
 rsvg-cairo-render.c |    4 ++--
 rsvg-css.c          |    8 +++++++-
 rsvg-filter.c       |   21 +++++++++++++--------
 rsvg-paint-server.c |   10 +++++++---
 rsvg-path.c         |    3 ++-
 rsvg-styles.c       |    4 ++--
 rsvg.h              |   32 ++++++++++++--------------------
 8 files changed, 54 insertions(+), 46 deletions(-)
---
diff --git a/rsvg-base.c b/rsvg-base.c
index 5696e1c..6210716 100644
--- a/rsvg-base.c
+++ b/rsvg-base.c
@@ -988,7 +988,7 @@ rsvg_get_base_uri_from_filename (const gchar * filename)
 }
 
 /**
- * rsvg_handle_set_base_uri
+ * rsvg_handle_set_base_uri:
  * @handle: A #RsvgHandle
  * @base_uri: The base uri
  *
@@ -1067,7 +1067,7 @@ rsvg_handle_get_base_uri (RsvgHandle * handle)
 }
 
 /**
- * rsvg_error_quark
+ * rsvg_error_quark:
  *
  * The error domain for RSVG
  *
@@ -1267,7 +1267,7 @@ rsvg_handle_get_desc (RsvgHandle * handle)
 }
 
 /**
- * rsvg_handle_get_dimensions
+ * rsvg_handle_get_dimensions:
  * @handle: A #RsvgHandle
  * @dimension_data: (out): A place to store the SVG's size
  *
@@ -1293,7 +1293,7 @@ rsvg_handle_get_dimensions (RsvgHandle * handle, RsvgDimensionData * dimension_d
 }
 
 /**
- * rsvg_handle_get_dimensions_sub
+ * rsvg_handle_get_dimensions_sub:
  * @handle: A #RsvgHandle
  * @dimension_data: (out): A place to store the SVG's size
  * @id: An element's id within the SVG, or NULL to get the dimension of the whole SVG. 
@@ -1402,7 +1402,7 @@ rsvg_handle_get_dimensions_sub (RsvgHandle * handle, RsvgDimensionData * dimensi
 }
 
 /**
- * rsvg_handle_get_position_sub
+ * rsvg_handle_get_position_sub:
  * @handle: A #RsvgHandle
  * @position_data: (out): A place to store the SVG fragment's position.
  * @id: An element's id within the SVG.
@@ -1521,7 +1521,7 @@ rsvg_handle_has_sub (RsvgHandle * handle,
 }
 
 /** 
- * rsvg_set_default_dpi
+ * rsvg_set_default_dpi:
  * @dpi: Dots Per Inch (aka Pixels Per Inch)
  *
  * Sets the DPI for the all future outgoing pixbufs. Common values are
@@ -1537,7 +1537,7 @@ rsvg_set_default_dpi (double dpi)
 }
 
 /** 
- * rsvg_set_default_dpi_x_y
+ * rsvg_set_default_dpi_x_y:
  * @dpi_x: Dots Per Inch (aka Pixels Per Inch)
  * @dpi_y: Dots Per Inch (aka Pixels Per Inch)
  *
@@ -1562,7 +1562,7 @@ rsvg_set_default_dpi_x_y (double dpi_x, double dpi_y)
 }
 
 /**
- * rsvg_handle_set_dpi
+ * rsvg_handle_set_dpi:
  * @handle: An #RsvgHandle
  * @dpi: Dots Per Inch (aka Pixels Per Inch)
  *
@@ -1579,7 +1579,7 @@ rsvg_handle_set_dpi (RsvgHandle * handle, double dpi)
 }
 
 /**
- * rsvg_handle_set_dpi_x_y
+ * rsvg_handle_set_dpi_x_y:
  * @handle: An #RsvgHandle
  * @dpi_x: Dots Per Inch (aka Pixels Per Inch)
  * @dpi_y: Dots Per Inch (aka Pixels Per Inch)
diff --git a/rsvg-cairo-render.c b/rsvg-cairo-render.c
index dd3b7f1..8622066 100644
--- a/rsvg-cairo-render.c
+++ b/rsvg-cairo-render.c
@@ -178,7 +178,7 @@ rsvg_cairo_new_drawing_ctx (cairo_t * cr, RsvgHandle * handle)
 }
 
 /**
- * rsvg_handle_render_cairo_sub
+ * rsvg_handle_render_cairo_sub:
  * @handle: A RsvgHandle
  * @cr: A Cairo renderer
  * @id: An element's id within the SVG, or %NULL to render the whole SVG. For
@@ -232,7 +232,7 @@ rsvg_handle_render_cairo_sub (RsvgHandle * handle, cairo_t * cr, const char *id)
 }
 
 /**
- * rsvg_handle_render_cairo
+ * rsvg_handle_render_cairo:
  * @handle: A RsvgHandle
  * @cr: A Cairo renderer
  *
diff --git a/rsvg-css.c b/rsvg-css.c
index 802739a..7813098 100644
--- a/rsvg-css.c
+++ b/rsvg-css.c
@@ -52,7 +52,7 @@
 #define UNSETINHERIT() G_STMT_START {if (inherit != NULL) *inherit = FALSE;} G_STMT_END
 
 /**
- * rsvg_css_parse_vbox
+ * rsvg_css_parse_vbox:
  * @vbox: The CSS viewBox
  * @x : The X output
  * @y: The Y output
@@ -307,7 +307,13 @@ rsvg_css_clip_rgb (gint rgb)
 #define PACK_RGB(r,g,b) (((r) << 16) | ((g) << 8) | (b))
 
 /**
+ * rsvg_css_parse_color:
+ * @str: string to parse
+ * @inherit: whether to inherit
+ *
  * Parse a CSS2 color specifier, return RGB value
+ *
+ * Returns: and RGB value
  */
 guint32
 rsvg_css_parse_color (const char *str, gboolean * inherit)
diff --git a/rsvg-filter.c b/rsvg-filter.c
index bc54f80..bc17cb5 100644
--- a/rsvg-filter.c
+++ b/rsvg-filter.c
@@ -479,13 +479,14 @@ rsvg_filter_context_free (RsvgFilterContext * ctx)
 }
 
 /**
- * rsvg_filter_render: Create a new surface applied the filter.
+ * rsvg_filter_render:
  * @self: a pointer to the filter to use
  * @source: the a #cairo_surface_t of type %CAIRO_SURFACE_TYPE_IMAGE
  * @context: the context
  *
- * This function will create a context for itself, set up the coordinate systems
- * execute all its little primatives and then clean up its own mess
+ * Create a new surface applied the filter. This function will create
+ * a context for itself, set up the coordinate systems execute all its
+ * little primatives and then clean up its own mess.
  * 
  * Returns: (transfer full): a new #cairo_surface_t
  **/
@@ -539,7 +540,7 @@ rsvg_filter_render (RsvgFilter *self,
 }
 
 /**
- * rsvg_filter_store_result: Files a result into a context.
+ * rsvg_filter_store_result:
  * @name: The name of the result
  * @result: The pointer to the result
  * @ctx: the context that this was called in
@@ -662,10 +663,12 @@ rsvg_filter_get_bg (RsvgFilterContext * ctx)
 
 /* FIXMEchpe: proper return value and out param! */
 /**
- * rsvg_filter_get_in: Gets a surface for a primitive
+ * rsvg_filter_get_result:
  * @name: The name of the surface
  * @ctx: the context that this was called in
- * @
+ *
+ * Gets a surface for a primitive
+ *
  * Returns: a pointer to the result that the name refers to, a special
  * surface if the name is a special keyword or NULL if nothing was found
  **/
@@ -731,10 +734,12 @@ rsvg_filter_get_in (GString * name, RsvgFilterContext * ctx)
 }
 
 /**
- * rsvg_filter_parse: Looks up an allready created filter.
+ * rsvg_filter_parse:
  * @defs: a pointer to the hash of definitions
  * @str: a string with the name of the filter to be looked up
  *
+ * Looks up an allready created filter.
+ *
  * Returns: a pointer to the filter that the name refers to, or NULL
  * if none was found
  **/
@@ -790,7 +795,7 @@ rsvg_filter_set_args (RsvgNode * self, RsvgHandle * ctx, RsvgPropertyBag * atts)
 }
 
 /**
- * rsvg_new_filter: Creates a black filter
+ * rsvg_new_filter:
  *
  * Creates a blank filter and assigns default values to everything
  **/
diff --git a/rsvg-paint-server.c b/rsvg-paint-server.c
index a330d3c..3a318c7 100644
--- a/rsvg-paint-server.c
+++ b/rsvg-paint-server.c
@@ -101,7 +101,7 @@ rsvg_paint_server_pattern (RsvgPattern * pattern)
 }
 
 /**
- * rsvg_paint_server_parse: Parse an SVG paint specification.
+ * rsvg_paint_server_parse:
  * @defs: Defs for looking up gradients.
  * @str: The SVG paint specification string to parse.
  *
@@ -152,8 +152,10 @@ rsvg_paint_server_parse (gboolean * inherit, const RsvgDefs * defs, const char *
 }
 
 /**
- * rsvg_paint_server_ref: Reference a paint server object.
+ * rsvg_paint_server_ref:
  * @ps: The paint server object to reference.
+ *
+ * Reference a paint server object.
  **/
 void
 rsvg_paint_server_ref (RsvgPaintServer * ps)
@@ -164,8 +166,10 @@ rsvg_paint_server_ref (RsvgPaintServer * ps)
 }
 
 /**
- * rsvg_paint_server_unref: Unreference a paint server object.
+ * rsvg_paint_server_unref:
  * @ps: The paint server object to unreference.
+ *
+ * Unreference a paint server object.
  **/
 void
 rsvg_paint_server_unref (RsvgPaintServer * ps)
diff --git a/rsvg-path.c b/rsvg-path.c
index 604b64c..69c7d47 100644
--- a/rsvg-path.c
+++ b/rsvg-path.c
@@ -210,7 +210,7 @@ rsvg_path_arc_segment (RSVGParsePathCtx * ctx,
 }
 
 /**
- * rsvg_path_arc: Add an RSVG arc to the path context.
+ * rsvg_path_arc:
  * @ctx: Path context.
  * @rx: Radius in x direction (before rotation).
  * @ry: Radius in y direction (before rotation).
@@ -220,6 +220,7 @@ rsvg_path_arc_segment (RSVGParsePathCtx * ctx,
  * @x: New x coordinate.
  * @y: New y coordinate.
  *
+ * Add an RSVG arc to the path context.
  **/
 static void
 rsvg_path_arc (RSVGParsePathCtx * ctx,
diff --git a/rsvg-styles.c b/rsvg-styles.c
index bc55b5a..c6e365b 100644
--- a/rsvg-styles.c
+++ b/rsvg-styles.c
@@ -1320,7 +1320,7 @@ rsvg_parse_transform (cairo_matrix_t *dst, const char *src)
 }
 
 /**
- * rsvg_parse_transform_attr: Parse transform attribute and apply to state.
+ * rsvg_parse_transform_attr:
  * @ctx: Rsvg context.
  * @state: State in which to apply the transform.
  * @str: String containing transform.
@@ -1369,7 +1369,7 @@ rsvg_lookup_apply_css_style (RsvgHandle * ctx, const char *target, RsvgState * s
 }
 
 /**
- * rsvg_parse_style_attrs: Parse style attribute.
+ * rsvg_parse_style_attrs:
  * @ctx: Rsvg context.
  * @state: Rsvg state
  * @tag: The SVG tag we're processing (eg: circle, ellipse), optionally %NULL
diff --git a/rsvg.h b/rsvg.h
index 10fb24f..f460146 100644
--- a/rsvg.h
+++ b/rsvg.h
@@ -53,19 +53,20 @@ G_BEGIN_DECLS
 GType rsvg_handle_get_type (void);
 
 /**
+ * RsvgError:
+ *
  * An enumeration representing possible error domains
  */
 typedef enum {
     RSVG_ERROR_FAILED
 } RsvgError;
 
-/**
- * 
- */
 #define RSVG_ERROR (rsvg_error_quark ())
 GQuark rsvg_error_quark (void) G_GNUC_CONST;
 
 /**
+ * RsvgHandle:
+ *
  * The RsvgHandle is an object representing the parsed form of a SVG
  */
 typedef struct _RsvgHandle RsvgHandle;
@@ -90,33 +91,24 @@ struct _RsvgHandle {
     gpointer _abi_padding[15];
 };
 
-/* RsvgDimensionData
+/**
+ * RsvgDimensionData:
+ * @width: SVG's width, in pixels
+ * @height: SVG's height, in pixels
+ * @em: em
+ * @ex: ex
  */
 struct _RsvgDimensionData {
-    /**
-     * SVG's width, in pixels
-     */
     int width;
-
-    /**
-     * SVG's height, in pixels
-     */
     int height;
-
-    /**
-     * em
-     */
     gdouble em;
-
-    /**
-     * ex
-     */
     gdouble ex;
 };
 
 /**
+ * RsvgPositionData:
  * Position of an SVG fragment.
- **/
+ */
 struct _RsvgPositionData {
     int x;
     int y;



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