[librsvgmm] Override documentation of close() and write()
- From: Daniel Elstner <daniel src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [librsvgmm] Override documentation of close() and write()
- Date: Mon, 7 Sep 2009 17:49:12 +0000 (UTC)
commit cd3302d8fe6f0f10e02b59257eeafa578c8bd116
Author: Daniel Elstner <daniel kitta gmail com>
Date: Mon Sep 7 19:45:02 2009 +0200
Override documentation of close() and write()
* librsvg/src/librsvg_docs_override.xml (rsvg_handle_{close,write}):
Override the gtk-doc documentation to accommodate the different error
handling using exceptions. On a side note, we really need a simpler
documentation override mechanism.
librsvg/src/librsvg_docs_override.xml | 26 ++++++++++++++++++++++++++
1 files changed, 26 insertions(+), 0 deletions(-)
---
diff --git a/librsvg/src/librsvg_docs_override.xml b/librsvg/src/librsvg_docs_override.xml
index 093d936..f52ce44 100644
--- a/librsvg/src/librsvg_docs_override.xml
+++ b/librsvg/src/librsvg_docs_override.xml
@@ -1,2 +1,28 @@
<root>
+<function name="rsvg_handle_close">
+<description>Closes the handle, to indicate that loading the image is complete.
+\throw Rsvg::Error Thrown if the loader could not close successfully.</description>
+<parameters>
+<parameter name="handle"/>
+<parameter name="error"/>
+</parameters>
+<return/>
+</function>
+<function name="rsvg_handle_write">
+<description>Loads the next @count bytes of the image.
+If the data could not be loaded successfully, the loader will be closed,
+and will not accept further writes.
+\throw Rsvg::Error Thrown if the data could not be loaded successfully.</description>
+<parameters>
+<parameter name="handle"/>
+<parameter name="buf">
+<parameter_description>Pointer to SVG data</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description>Length of the @buf buffer in bytes</parameter_description>
+</parameter>
+<parameter name="error"/>
+</parameters>
+<return/>
+</function>
</root>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]