GNOME.org
 

[gdk-pixbuf] Documentation fixes

commit 03f696663eb50ff2c7784fc89d5397d3d1c7e082
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Sep 3 13:58:10 2012 -0400

    Documentation fixes
    
    Patch by  RafaÅ MuÅyÅo,
    https://bugzilla.gnome.org/show_bug.cgi?id=676430

 contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlib.c    |    4 ++--
 contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlibrgb.c |    4 ++--
 docs/reference/gdk-pixbuf/gdk-pixbuf.xml     |   13 +++++--------
 gdk-pixbuf/gdk-pixbuf-animation.c            |    4 ++--
 gdk-pixbuf/gdk-pixbuf-io.c                   |    6 +++---
 gdk-pixbuf/gdk-pixbuf.c                      |    2 +-
 gdk-pixbuf/gdk-pixdata.c                     |    2 +-
 7 files changed, 16 insertions(+), 19 deletions(-)
---
diff --git a/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlib.c b/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlib.c
index ceb9d1e..f08a0da 100644
--- a/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlib.c
+++ b/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlib.c
@@ -24,8 +24,8 @@
 
 /**
  * SECTION:gdk-pixbuf-xlib-init
- * @Short_description: Initializing the &gdk-pixbuf; Xlib library.
- * @Title: &gdk-pixbuf; Xlib initialization
+ * @Short_description: Initializing the gdk-pixbuf Xlib library.
+ * @Title: gdk-pixbuf Xlib initialization
  * @See_also:    XlibRGB
  * 
  * In addition to the normal Gdk-specific functions, the &gdk-pixbuf;
diff --git a/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlibrgb.c b/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlibrgb.c
index ff749c5..cb0c37f 100644
--- a/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlibrgb.c
+++ b/contrib/gdk-pixbuf-xlib/gdk-pixbuf-xlibrgb.c
@@ -474,7 +474,7 @@ xlib_rgb_colorcube_222 (void)
 
 /**
  * xlib_rgb_set_verbose:
- * @verbose: %True to be verbose
+ * @verbose: True to be verbose
  * 
  * Enables/disables debug spew.
  **/
@@ -486,7 +486,7 @@ xlib_rgb_set_verbose (Bool verbose)
 
 /**
  * xlib_rgb_set_install:
- * @install: %True to install a colormap
+ * @install: True to install a colormap
  * 
  * Sets whether we install an RGB colormap.
  **/
diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.xml b/docs/reference/gdk-pixbuf/gdk-pixbuf.xml
index 1c904e3..41dab6e 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf.xml
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.xml
@@ -91,6 +91,11 @@
 
     <xi:include href="xml/gdk-pixbuf-loader.xml" />
     <xi:include href="xml/module_interface.xml" />
+
+    <xi:include href="xml/gdk-pixbuf-xlib-init.xml" />
+    <xi:include href="xml/gdk-pixbuf-xlib-rendering.xml" />
+    <xi:include href="xml/gdk-pixbuf-xlib-from-drawables.xml" />
+    <xi:include href="xml/gdk-pixbuf-xlib-rgb.xml" />
   </reference>
 
   <reference>
@@ -131,10 +136,6 @@
     <title>Index of new symbols in 2.8</title>
     <xi:include href="xml/api-index-2.8.xml"><xi:fallback /></xi:include>
   </index>
-  <index id="api-index-2-10" role="2.10">
-    <title>Index of new symbols in 2.10</title>
-    <xi:include href="xml/api-index-2.10.xml"><xi:fallback /></xi:include>
-  </index>
   <index id="api-index-2-12" role="2.12">
     <title>Index of new symbols in 2.12</title>
     <xi:include href="xml/api-index-2.12.xml"><xi:fallback /></xi:include>
@@ -143,10 +144,6 @@
     <title>Index of new symbols in 2.14</title>
     <xi:include href="xml/api-index-2.14.xml"><xi:fallback /></xi:include>
   </index>
-  <index id="api-index-2-14" role="2.14">
-    <title>Index of new symbols in 2.14</title>
-    <xi:include href="xml/api-index-2.14.xml"><xi:fallback /></xi:include>
-  </index>
   <index id="api-index-2-26" role="2.26">
     <title>Index of new symbols in 2.26</title>
     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
diff --git a/gdk-pixbuf/gdk-pixbuf-animation.c b/gdk-pixbuf/gdk-pixbuf-animation.c
index 845acfe..3ad8141 100644
--- a/gdk-pixbuf/gdk-pixbuf-animation.c
+++ b/gdk-pixbuf/gdk-pixbuf-animation.c
@@ -548,8 +548,8 @@ gdk_pixbuf_animation_iter_on_currently_loading_frame (GdkPixbufAnimationIter *it
  *
  * If this function returns %FALSE, there's no need to update the animation
  * display, assuming the display had been rendered prior to advancing;
- * if %TRUE, you need to call gdk_animation_iter_get_pixbuf() and update the
- * display with the new pixbuf.
+ * if %TRUE, you need to call gdk_pixbuf_animation_iter_get_pixbuf()
+ * and update the display with the new pixbuf.
  *
  * Returns: %TRUE if the image may need updating
  * 
diff --git a/gdk-pixbuf/gdk-pixbuf-io.c b/gdk-pixbuf/gdk-pixbuf-io.c
index 47f7748..411ceb6 100644
--- a/gdk-pixbuf/gdk-pixbuf-io.c
+++ b/gdk-pixbuf/gdk-pixbuf-io.c
@@ -1513,7 +1513,7 @@ load_from_stream (GdkPixbufLoader  *loader,
  * The file format is detected automatically. If %NULL is returned, then 
  * @error will be set. The @cancellable can be used to abort the operation
  * from another thread. If the operation was cancelled, the error 
- * %GIO_ERROR_CANCELLED will be returned. Other possible errors are in 
+ * %G_IO_ERROR_CANCELLED will be returned. Other possible errors are in 
  * the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. 
  *
  * The image will be scaled to fit in the requested size, optionally 
@@ -1643,7 +1643,7 @@ gdk_pixbuf_new_from_stream_at_scale_async (GInputStream        *stream,
  * The file format is detected automatically. If %NULL is returned, then 
  * @error will be set. The @cancellable can be used to abort the operation
  * from another thread. If the operation was cancelled, the error 
- * %GIO_ERROR_CANCELLED will be returned. Other possible errors are in 
+ * %G_IO_ERROR_CANCELLED will be returned. Other possible errors are in 
  * the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains. 
  *
  * The stream is not closed.
@@ -2773,7 +2773,7 @@ save_to_stream (const gchar  *buffer,
  * "bmp". See gdk_pixbuf_save_to_buffer() for more details.
  *
  * The @cancellable can be used to abort the operation from another 
- * thread. If the operation was cancelled, the error %GIO_ERROR_CANCELLED 
+ * thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED 
  * will be returned. Other possible errors are in the #GDK_PIXBUF_ERROR 
  * and %G_IO_ERROR domains. 
  *
diff --git a/gdk-pixbuf/gdk-pixbuf.c b/gdk-pixbuf/gdk-pixbuf.c
index 284ab32..3eaa91b 100644
--- a/gdk-pixbuf/gdk-pixbuf.c
+++ b/gdk-pixbuf/gdk-pixbuf.c
@@ -764,7 +764,7 @@ gdk_pixbuf_get_option (GdkPixbuf   *pixbuf,
  * @key: a nul-terminated string.
  * @value: a nul-terminated string.
  * 
- * Attaches a key/value pair as an option to a #GdkPixbuf. If %key already
+ * Attaches a key/value pair as an option to a #GdkPixbuf. If @key already
  * exists in the list of options attached to @pixbuf, the new value is 
  * ignored and %FALSE is returned.
  *
diff --git a/gdk-pixbuf/gdk-pixdata.c b/gdk-pixbuf/gdk-pixdata.c
index a7a92aa..99129fe 100644
--- a/gdk-pixbuf/gdk-pixdata.c
+++ b/gdk-pixbuf/gdk-pixdata.c
@@ -191,7 +191,7 @@ get_uint32 (const guint8 *stream, guint *result)
  * #GdkPixdata fields in network byte order, plus the @pixel_data
  * bytes the structure points to.
  * The @pixdata contents are reconstructed byte by byte and are checked
- * for validity. This function may fail with %GDK_PIXBUF_CORRUPT_IMAGE
+ * for validity. This function may fail with %GDK_PIXBUF_ERROR_CORRUPT_IMAGE
  * or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE.
  *
  * Return value: Upon successful deserialization %TRUE is returned,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]