diff options
author | Evan Nemerson <evan@nemerson.com> | 2014-06-03 13:52:57 -0700 |
---|---|---|
committer | Evan Nemerson <evan@nemerson.com> | 2014-06-10 07:43:20 -0700 |
commit | 59592914f2250b5419b782d77f0359021dae1e86 (patch) | |
tree | e988d225eeb39ddc70bb9a9066680ec633924924 | |
parent | 63925d7db803162fbd2c27065a57d13e409f5ac6 (diff) | |
download | librsvg-59592914f2250b5419b782d77f0359021dae1e86.tar.gz |
docs: use %, #, and @ more consistently for contants, types, and args
https://bugzilla.gnome.org/show_bug.cgi?id=731182
-rw-r--r-- | rsvg-base-file-util.c | 10 | ||||
-rw-r--r-- | rsvg-base.c | 28 | ||||
-rw-r--r-- | rsvg-cairo-render.c | 4 | ||||
-rw-r--r-- | rsvg-filter.c | 4 | ||||
-rw-r--r-- | rsvg-gobject.c | 2 | ||||
-rw-r--r-- | rsvg-paint-server.c | 2 | ||||
-rw-r--r-- | rsvg.c | 8 | ||||
-rw-r--r-- | rsvg.h | 4 |
8 files changed, 31 insertions, 31 deletions
diff --git a/rsvg-base-file-util.c b/rsvg-base-file-util.c index 25df038e..52d0f704 100644 --- a/rsvg-base-file-util.c +++ b/rsvg-base-file-util.c @@ -47,12 +47,12 @@ rsvg_handle_fill_with_data (RsvgHandle * handle, /** * rsvg_handle_new_from_data: * @data: (array length=data_len): The SVG data - * @data_len: The length of #data, in bytes + * @data_len: The length of @data, in bytes * @error: return location for errors * - * Loads the SVG specified by #data. + * Loads the SVG specified by @data. * - * Returns: A RsvgHandle or %NULL if an error occurs. + * Returns: A #RsvgHandle or %NULL if an error occurs. * Since: 2.14 */ RsvgHandle * @@ -77,9 +77,9 @@ rsvg_handle_new_from_data (const guint8 * data, gsize data_len, GError ** error) * @file_name: The file name to load. If built with gnome-vfs, can be a URI. * @error: return location for errors * - * Loads the SVG specified by #file_name. + * Loads the SVG specified by @file_name. * - * Returns: A RsvgHandle or %NULL if an error occurs. + * Returns: A #RsvgHandle or %NULL if an error occurs. * Since: 2.14 */ RsvgHandle * diff --git a/rsvg-base.c b/rsvg-base.c index fb829e71..d5052996 100644 --- a/rsvg-base.c +++ b/rsvg-base.c @@ -1204,7 +1204,7 @@ rsvg_drawing_ctx_free (RsvgDrawingCtx * handle) * @handle: An #RsvgHandle * * Returns the SVG's metadata in UTF-8 or %NULL. You must make a copy - * of this metadata if you wish to use it after #handle has been freed. + * of this metadata if you wish to use it after @handle has been freed. * * Returns: The SVG's title * @@ -1228,7 +1228,7 @@ rsvg_handle_get_metadata (RsvgHandle * handle) * @handle: An #RsvgHandle * * Returns the SVG's title in UTF-8 or %NULL. You must make a copy - * of this title if you wish to use it after #handle has been freed. + * of this title if you wish to use it after @handle has been freed. * * Returns: The SVG's title * @@ -1252,7 +1252,7 @@ rsvg_handle_get_title (RsvgHandle * handle) * @handle: An #RsvgHandle * * Returns the SVG's description in UTF-8 or %NULL. You must make a copy - * of this description if you wish to use it after #handle has been freed. + * of this description if you wish to use it after @handle has been freed. * * Returns: The SVG's description * @@ -1301,7 +1301,7 @@ rsvg_handle_get_dimensions (RsvgHandle * handle, RsvgDimensionData * dimension_d * 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. + * @id: An element's id within the SVG, or %NULL to get the dimension of the whole SVG. * For example, if you have a layer called "layer1" for that you want to get the dimension, * pass "#layer1" as the id. * @@ -1530,7 +1530,7 @@ rsvg_handle_has_sub (RsvgHandle * handle, * @dpi: Dots Per Inch (aka Pixels Per Inch) * * Sets the DPI for the all future outgoing pixbufs. Common values are - * 75, 90, and 300 DPI. Passing a number <= 0 to #dpi will + * 75, 90, and 300 DPI. Passing a number <= 0 to @dpi will * reset the DPI to whatever the default value happens to be. * * Since: 2.8 @@ -1547,7 +1547,7 @@ rsvg_set_default_dpi (double dpi) * @dpi_y: Dots Per Inch (aka Pixels Per Inch) * * Sets the DPI for the all future outgoing pixbufs. Common values are - * 75, 90, and 300 DPI. Passing a number <= 0 to #dpi will + * 75, 90, and 300 DPI. Passing a number <= 0 to @dpi will * reset the DPI to whatever the default value happens to be. * * Since: 2.8 @@ -1572,7 +1572,7 @@ rsvg_set_default_dpi_x_y (double dpi_x, double dpi_y) * @dpi: Dots Per Inch (aka Pixels Per Inch) * * Sets the DPI for the outgoing pixbuf. Common values are - * 75, 90, and 300 DPI. Passing a number <= 0 to #dpi will + * 75, 90, and 300 DPI. Passing a number <= 0 to @dpi will * reset the DPI to whatever the default value happens to be. * * Since: 2.8 @@ -1590,7 +1590,7 @@ rsvg_handle_set_dpi (RsvgHandle * handle, double dpi) * @dpi_y: Dots Per Inch (aka Pixels Per Inch) * * Sets the DPI for the outgoing pixbuf. Common values are - * 75, 90, and 300 DPI. Passing a number <= 0 to #dpi_x or #dpi_y will + * 75, 90, and 300 DPI. Passing a number <= 0 to #dpi_x or @dpi_y will * reset the DPI to whatever the default value happens to be. * * Since: 2.8 @@ -1648,9 +1648,9 @@ rsvg_handle_set_size_callback (RsvgHandle * handle, * @count: length of the @buf buffer in bytes * @error: (allow-none): a location to store a #GError, or %NULL * - * Loads the next @count bytes of the image. This will return #TRUE if the data - * was loaded successful, and #FALSE if an error occurred. In the latter case, - * the loader will be closed, and will not accept further writes. If FALSE is + * Loads the next @count bytes of the image. This will return %TRUE if the data + * was loaded successful, and %FALSE if an error occurred. In the latter case, + * the loader will be closed, and will not accept further writes. If %FALSE is * returned, @error will be set to an error from the #RsvgError domain. Errors * from #GIOErrorEnum are also possible. * @@ -1738,7 +1738,7 @@ rsvg_handle_close (RsvgHandle * handle, GError ** error) * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the - * operation was cancelled, the error G_IO_ERROR_CANCELLED will be + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be * returned. * * Returns: %TRUE if reading @stream succeeded, or %FALSE otherwise @@ -1835,7 +1835,7 @@ rsvg_handle_read_stream_sync (RsvgHandle *handle, * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the - * operation was cancelled, the error G_IO_ERROR_CANCELLED will be + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be * returned. * * Returns: a new #RsvgHandle on success, or %NULL with @error filled in @@ -1878,7 +1878,7 @@ rsvg_handle_new_from_gfile_sync (GFile *file, * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the - * operation was cancelled, the error G_IO_ERROR_CANCELLED will be + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be * returned. * * Returns: a new #RsvgHandle on success, or %NULL with @error filled in diff --git a/rsvg-cairo-render.c b/rsvg-cairo-render.c index 8622066c..8519345c 100644 --- a/rsvg-cairo-render.c +++ b/rsvg-cairo-render.c @@ -179,7 +179,7 @@ rsvg_cairo_new_drawing_ctx (cairo_t * cr, RsvgHandle * handle) /** * rsvg_handle_render_cairo_sub: - * @handle: A RsvgHandle + * @handle: A #RsvgHandle * @cr: A Cairo renderer * @id: An element's id within the SVG, or %NULL to render the whole SVG. For * example, if you have a layer called "layer1" that you wish to render, pass @@ -233,7 +233,7 @@ rsvg_handle_render_cairo_sub (RsvgHandle * handle, cairo_t * cr, const char *id) /** * rsvg_handle_render_cairo: - * @handle: A RsvgHandle + * @handle: A #RsvgHandle * @cr: A Cairo renderer * * Draws a SVG to a Cairo surface diff --git a/rsvg-filter.c b/rsvg-filter.c index 2b6595ff..39802e5a 100644 --- a/rsvg-filter.c +++ b/rsvg-filter.c @@ -670,7 +670,7 @@ rsvg_filter_get_bg (RsvgFilterContext * ctx) * 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 + * surface if the name is a special keyword or %NULL if nothing was found **/ static RsvgFilterPrimitiveOutput rsvg_filter_get_result (GString * name, RsvgFilterContext * ctx) @@ -740,7 +740,7 @@ rsvg_filter_get_in (GString * name, RsvgFilterContext * ctx) * * Looks up an allready created filter. * - * Returns: a pointer to the filter that the name refers to, or NULL + * Returns: a pointer to the filter that the name refers to, or %NULL * if none was found **/ RsvgFilter * diff --git a/rsvg-gobject.c b/rsvg-gobject.c index 07ad0cd5..4e61a449 100644 --- a/rsvg-gobject.c +++ b/rsvg-gobject.c @@ -332,7 +332,7 @@ rsvg_handle_class_init (RsvgHandleClass * klass) * rsvg_handle_free: * @handle: An #RsvgHandle * - * Frees #handle. + * Frees @handle. * Deprecated: Use g_object_unref() instead. **/ void diff --git a/rsvg-paint-server.c b/rsvg-paint-server.c index 07c76be9..f7886074 100644 --- a/rsvg-paint-server.c +++ b/rsvg-paint-server.c @@ -108,7 +108,7 @@ rsvg_paint_server_pattern (RsvgPattern * pattern) * Parses the paint specification @str, creating a new paint server * object. * - * Return value: The newly created paint server, or NULL on error. + * Return value: The newly created paint server, or %NULL on error. **/ RsvgPaintServer * rsvg_paint_server_parse (gboolean * inherit, const RsvgDefs * defs, const char *str, @@ -51,13 +51,13 @@ * example, if you have a layer called "layer1" that you wish to render, pass * "##layer1" as the id. * - * Returns the pixbuf loaded by #handle. The pixbuf returned will be reffed, so + * Returns the pixbuf loaded by @handle. The pixbuf returned will be reffed, so * the caller of this function must assume that ref. If insufficient data has * been read to create the pixbuf, or an error occurred in loading, then %NULL * will be returned. Note that the pixbuf may not be complete until * @rsvg_handle_close has been called. * - * Returns: (transfer full): the pixbuf loaded by #handle, or %NULL. + * Returns: (transfer full): the pixbuf loaded by @handle, or %NULL. * * Since: 2.14 **/ @@ -105,13 +105,13 @@ rsvg_handle_get_pixbuf_sub (RsvgHandle * handle, const char *id) * rsvg_handle_get_pixbuf: * @handle: An #RsvgHandle * - * Returns the pixbuf loaded by #handle. The pixbuf returned will be reffed, so + * Returns the pixbuf loaded by @handle. The pixbuf returned will be reffed, so * the caller of this function must assume that ref. If insufficient data has * been read to create the pixbuf, or an error occurred in loading, then %NULL * will be returned. Note that the pixbuf may not be complete until * @rsvg_handle_close has been called. * - * Returns: (transfer full): the pixbuf loaded by #handle, or %NULL. + * Returns: (transfer full): the pixbuf loaded by @handle, or %NULL. **/ GdkPixbuf * rsvg_handle_get_pixbuf (RsvgHandle * handle) @@ -67,7 +67,7 @@ GQuark rsvg_error_quark (void) G_GNUC_CONST; /** * RsvgHandle: * - * The RsvgHandle is an object representing the parsed form of a SVG + * The #RsvgHandle is an object representing the parsed form of a SVG */ typedef struct _RsvgHandle RsvgHandle; typedef struct RsvgHandlePrivate RsvgHandlePrivate; @@ -183,7 +183,7 @@ RSVG_DEPRECATED_FOR(g_object_unref) void rsvg_handle_free (RsvgHandle * handle); /** - * RsvgSizeFunc (): + * RsvgSizeFunc: * @width: Pointer to where to set/store the width * @height: Pointer to where to set/store the height * @user_data: User data pointer |