[librsvgmm] Move documentation overrides into source file



commit ef557482be04a605809f528517d71b9fb6406cdf
Author: Daniel Elstner <daniel kitta gmail com>
Date:   Wed Sep 16 18:01:07 2009 +0200

    Move documentation overrides into source file
    
    * librsvg/src/rsvg.hg: Use plain Doxygen documentation comments to
    override the inherited method documentation, as gmmproc is now able
    to recognize a Doxygen comment preceding a method declaration.
    * librsvg/src/librsvg_docs_override.xml: Delete obsolete file.
    * librsvg/src/filelist.am: Remove librsvg_docs_override.xml.

 librsvg/src/filelist.am               |    3 +--
 librsvg/src/librsvg_docs_override.xml |   28 ----------------------------
 librsvg/src/rsvg.hg                   |   11 +++++++++++
 3 files changed, 12 insertions(+), 30 deletions(-)
---
diff --git a/librsvg/src/filelist.am b/librsvg/src/filelist.am
index 8a3ff0d..86c8e19 100644
--- a/librsvg/src/filelist.am
+++ b/librsvg/src/filelist.am
@@ -5,8 +5,7 @@ files_defs =			\
 	librsvg_enum.defs	\
 	librsvg_extra.defs	\
 	librsvg_method.defs	\
-	librsvg_docs.xml	\
-	librsvg_docs_override.xml
+	librsvg_docs.xml
 
 files_hg  = rsvg.hg
 files_ccg = $(files_hg:.hg=.ccg)
diff --git a/librsvg/src/rsvg.hg b/librsvg/src/rsvg.hg
index 512089b..a659051 100644
--- a/librsvg/src/rsvg.hg
+++ b/librsvg/src/rsvg.hg
@@ -110,7 +110,18 @@ public:
   _WRAP_METHOD(void set_dpi(double dpi), rsvg_handle_set_dpi)
   _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 count Size of the buffer in bytes
+   * @throw Rsvg::Error Thrown if the data could not be loaded successfully
+   */
   _WRAP_METHOD(void write(const guint8* buf, gsize count), rsvg_handle_write, errthrow)
+
+  /** Closes the handle, to indicate that loading the image is complete.
+   * @throw Rsvg::Error Thrown if the loader could not close successfully
+   */
   _WRAP_METHOD(void close(), rsvg_handle_close, errthrow)
 
   _WRAP_METHOD(Glib::ustring get_base_uri() const, rsvg_handle_get_base_uri)



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