[gtkmm] Pixbuf: Minor documentation improvement.



commit 19ea2612698a226203fe8f5b29fad602d52d32b9
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Feb 2 10:06:05 2011 +0100

    Pixbuf: Minor documentation improvement.
    
    	* gdk/src/pixbuf.hg: Dealt with a TODO comment.

 ChangeLog         |    6 ++++++
 gdk/src/pixbuf.hg |   10 ++++++----
 2 files changed, 12 insertions(+), 4 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 6a41b31..5461a68 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2011-02-02  Murray Cumming  <murrayc murrayc com>
+
+	Pixbuf: Minor documentation improvement.
+
+	* gdk/src/pixbuf.hg: Dealt with a TODO comment.
+
 2011-02-01  Murray Cumming  <murrayc murrayc com>
 
 	Require the recent glibmm version for the std::vector utilities.
diff --git a/gdk/src/pixbuf.hg b/gdk/src/pixbuf.hg
index b152fa4..f4c60e1 100644
--- a/gdk/src/pixbuf.hg
+++ b/gdk/src/pixbuf.hg
@@ -268,8 +268,8 @@ public:
 
   /** Saves pixbuf to a file in format @a type.
    * By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed.
-   * TThe list of all writable formats can be determined by using Gdk::Pixbuf::get_formats() with
-   * Gdk::PixbufFormat::is_writable().
+   * The list of all writable formats can be determined by using get_formats() with
+   * is_writable().
    *
    * @param filename The path of the file to be created.
    * @param type The file type.
@@ -282,7 +282,7 @@ public:
 
   /** Saves pixbuf to a file in format @a type.
    * By default, "jpeg", "png", "ico" and "bmp" are possible file formats to save in, but more formats may be installed.
-   * TThe list of all writable formats can be determined by using Gdk::Pixbuf::get_formats() with
+   * TThe list of all writable formats can be determined by using get_formats() with
    * Gdk::PixbufFormat::is_writable().
    *
    * The @a option_keys and @option_values, if not empty, should contain pairs of strings that modify the save parameters.
@@ -435,7 +435,9 @@ gboolean gdk_pixbuf_save_to_callbackv   (GdkPixbuf  *pixbuf,
   //This creates a new GdkPixbuf or returns the original with a reference.
   _WRAP_METHOD(Glib::RefPtr<Pixbuf> apply_embedded_orientation(), gdk_pixbuf_apply_embedded_orientation)
 
-  //TODO: Documentation
+  /** Obtains the available information about the image formats supported by GdkPixbuf.
+   * @result A list of PixbufFormats describing the supported image formats. 
+   */
   static std::vector<PixbufFormat> get_formats();
   _IGNORE(gdk_pixbuf_get_formats)
 };



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