[librsvgmm] Override documentation of remaining Handle methods

[Daniel Elstner <daniel src gnome org>]

commit 16d7c6cb85f714e6f1e889682e22157751e4342c
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Fri Oct 9 10:22:27 2009 +0200

    Override documentation of remaining Handle methods
    
    * librsvg/src/rsvg.hg (Handle): Override the inherited documentation
    of the remaining methods to improve upon the Doxygen output, and to
    suppress the confusing "Since x.y" references to non-existing version
    numbers of librsvgmm.

 librsvg/src/rsvg.hg |   47 +++++++++++++++++++++++++++++++++++++++++------
 1 files changed, 41 insertions(+), 6 deletions(-)
---
diff --git a/librsvg/src/rsvg.hg b/librsvg/src/rsvg.hg
index d887f27..d785c64 100644
--- a/librsvg/src/rsvg.hg
+++ b/librsvg/src/rsvg.hg
@@ -98,7 +98,7 @@ dnl // loader module can be used instead.
   _IGNORE(rsvg_handle_free, rsvg_handle_set_size_callback,
           rsvg_handle_get_pixbuf, rsvg_handle_get_pixbuf_sub)
 protected:
-  _CTOR_DEFAULT()
+  _CTOR_DEFAULT
 
 public:
   /** Create an empty SVG handle.
@@ -107,7 +107,7 @@ public:
   _WRAP_CREATE()
 
   /** Load an SVG from a memory buffer.
-   * @param data Pointer to the SVG data in memory.
+   * @param[in] data Pointer to the SVG data in memory.
    * @param data_len Length of the SVG data in bytes.
    * @return A pointer to the created SVG handle.
    * @throw Rsvg::Error Thrown if the SVG could not be loaded.
@@ -123,13 +123,25 @@ public:
   _WRAP_METHOD(static Glib::RefPtr<Handle> create_from_file(const std::string& file_name),
                rsvg_handle_new_from_file, errthrow)
 
+  /** Sets the DPI for future pixel calculations.
+   * Common values are 75, 90, and 300 DPI. Passing a number <= 0 to @a dpi
+   * will reset the DPI to whatever the default value happens to be.
+   * @param dpi Dots per inch (aka pixels per inch).
+   */
   _WRAP_METHOD(void set_dpi(double dpi), rsvg_handle_set_dpi)
+
+  /** Sets the DPI for future pixel calculations.
+   * Common values are 75, 90, and 300 DPI. Passing a number <= 0 to @a dpi_x
+   * or @a dpi_y will reset the DPI to whatever the default value happens to be.
+   * @param dpi_x Horizontal dots per inch (aka pixels per inch).
+   * @param dpi_y Vertical dots per inch (aka pixels per inch).
+   */
   _WRAP_METHOD(void set_dpi(double dpi_x, double dpi_y), rsvg_handle_set_dpi_x_y)
 
   /** Loads the next @a count bytes of the image.
    * If the data could not be loaded successfully, the loader will be closed,
    * and will not accept further writes.
-   * @param buf Pointer to SVG data.
+   * @param[in] buf Pointer to SVG data.
    * @param count Size of the buffer in bytes.
    * @throw Rsvg::Error Thrown if the data could not be loaded successfully.
    */
@@ -140,17 +152,25 @@ public:
    */
   _WRAP_METHOD(void close(), rsvg_handle_close, errthrow)
 
+  /** Gets the base URI for this Rsvg::Handle.
+   * @return The base URI, possibly empty.
+   */
   _WRAP_METHOD(Glib::ustring get_base_uri() const, rsvg_handle_get_base_uri)
+
+  /** Set the base URI for this SVG.
+   * This can only be called before write() has been called.
+   * @param base_uri The base URI.
+   */
   _WRAP_METHOD(void set_base_uri(const Glib::ustring& base_uri), rsvg_handle_set_base_uri)
 
   /** Gets the size of the SVG.
-   * @param dimension_data Result object.
+   * @param[out] dimension_data Result object.
    */
   _WRAP_METHOD(void get_dimensions(DimensionData& dimension_data) const,
                rsvg_handle_get_dimensions)
 
   /** Gets the size of an SVG fragment.
-   * @param dimension_data Result object.
+   * @param[out] dimension_data Result object.
    * @param id An element's ID within the SVG, or the empty string to get
    *  the dimensions of the whole SVG. For example, if you have a layer
    *  called <tt>"layer1"</tt> for that you want to get the dimensions,
@@ -162,7 +182,7 @@ public:
                rsvg_handle_get_dimensions_sub)
 
   /** Gets the position of an SVG fragment.
-   * @param position_data Result object.
+   * @param[out] position_data Result object.
    * @param id An element's ID within the SVG. For example, if you have
    *  a layer called <tt>"layer1"</tt> for that you want to get the position,
    *  pass <tt>"#layer1"</tt> as the ID.
@@ -172,6 +192,10 @@ public:
                                      const Glib::ustring& id) const,
                rsvg_handle_get_position_sub)
 
+  /** Checks whether the element @a id exists in the SVG document.
+   * @param id An element's ID within the SVG.
+   * @return <tt>true</tt> if @a id exists in the SVG document.
+   */
   _WRAP_METHOD(bool has_sub(const Glib::ustring& id) const, rsvg_handle_has_sub)
 
   /** Draws an SVG to a cairo surface.
@@ -192,8 +216,19 @@ public:
                                const Glib::ustring& id) const,
                rsvg_handle_render_cairo_sub)
 
+  /** Returns the SVG's title.
+   * @return The SVG's title.
+   */
   _WRAP_METHOD(Glib::ustring get_title() const, rsvg_handle_get_title)
+
+  /** Returns the SVG's description.
+   * @return The SVG's description.
+   */
   _WRAP_METHOD(Glib::ustring get_desc() const, rsvg_handle_get_desc)
+
+  /** Returns the SVG's metadata.
+   * @return The SVG's metadata.
+   */
   _WRAP_METHOD(Glib::ustring get_metadata() const, rsvg_handle_get_metadata)
 
   _WRAP_PROPERTY("dpi-x", double)