[gmime/gmime-2-4] updated gtk-doc comments and mono bindings



commit 6933dc551f9fed400e58b0212496a03a974a3863
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Mon Apr 27 10:48:01 2009 -0400

    updated gtk-doc comments and mono bindings
---
 gmime/gmime-stream-file.c |   10 +++++-----
 gmime/gmime-stream-fs.c   |    2 +-
 gmime/gmime-stream-mem.c  |    4 ++--
 mono/GMime.metadata       |    2 ++
 mono/gmime-api.raw        |   13 +++++++++++--
 5 files changed, 21 insertions(+), 10 deletions(-)

diff --git a/gmime/gmime-stream-file.c b/gmime/gmime-stream-file.c
index 5a9e29c..4dc3a03 100644
--- a/gmime/gmime-stream-file.c
+++ b/gmime/gmime-stream-file.c
@@ -373,7 +373,7 @@ stream_substream (GMimeStream *stream, gint64 start, gint64 end)
 
 /**
  * g_mime_stream_file_new:
- * @fp: file pointer
+ * @fp: a FILE pointer
  *
  * Creates a new #GMimeStreamFile object around @fp.
  *
@@ -402,7 +402,7 @@ g_mime_stream_file_new (FILE *fp)
 
 /**
  * g_mime_stream_file_new_with_bounds:
- * @fp: file pointer
+ * @fp: a FILE pointer
  * @start: start boundary
  * @end: end boundary
  *
@@ -430,7 +430,7 @@ g_mime_stream_file_new_with_bounds (FILE *fp, gint64 start, gint64 end)
 
 /**
  * g_mime_stream_file_get_owner:
- * @stream: file stream
+ * @stream: a #GMimeStreamFile
  *
  * Gets whether or not @stream owns the backend FILE pointer.
  *
@@ -448,8 +448,8 @@ g_mime_stream_file_get_owner (GMimeStreamFile *stream)
 
 /**
  * g_mime_stream_file_set_owner:
- * @stream: file stream
- * @owner: owner
+ * @stream: a #GMimeStreamFile
+ * @owner: %TRUE if this stream should own the FILE pointer or %FALSE otherwise
  *
  * Sets whether or not @stream owns the backend FILE pointer.
  *
diff --git a/gmime/gmime-stream-fs.c b/gmime/gmime-stream-fs.c
index aaec7e6..7857986 100644
--- a/gmime/gmime-stream-fs.c
+++ b/gmime/gmime-stream-fs.c
@@ -503,7 +503,7 @@ g_mime_stream_fs_get_owner (GMimeStreamFs *stream)
 /**
  * g_mime_stream_fs_set_owner:
  * @stream: a #GMimeStreamFs
- * @owner: owner
+ * @owner: %TRUE if this stream should own the file descriptor or %FALSE otherwise
  *
  * Sets whether or not @stream owns the backend file descriptor.
  *
diff --git a/gmime/gmime-stream-mem.c b/gmime/gmime-stream-mem.c
index d94850d..faae7d4 100644
--- a/gmime/gmime-stream-mem.c
+++ b/gmime/gmime-stream-mem.c
@@ -420,7 +420,7 @@ g_mime_stream_mem_get_byte_array (GMimeStreamMem *mem)
  * Sets the byte array on the memory stream.
  *
  * Note: The memory stream is not responsible for freeing the byte
- * array.
+ * array. Use g_mime_stream_mem_set_owner() to change this behavior.
  **/
 void
 g_mime_stream_mem_set_byte_array (GMimeStreamMem *mem, GByteArray *array)
@@ -465,7 +465,7 @@ g_mime_stream_mem_get_owner (GMimeStreamMem *mem)
 /**
  * g_mime_stream_mem_set_owner:
  * @mem: a #GMimeStreamMem
- * @owner: owner
+ * @owner: %TRUE if this stream should own the #GByteArray or %FALSE otherwise
  *
  * Sets whether or not @mem owns the backend memory buffer.
  *
diff --git a/mono/GMime.metadata b/mono/GMime.metadata
index 7623d74..7b3df6a 100644
--- a/mono/GMime.metadata
+++ b/mono/GMime.metadata
@@ -124,6 +124,8 @@
 
   <!-- HeaderList -->
   <remove-node path="/api/namespace/struct[ cname='GMimeHeaderList']/method[ cname='g_mime_header_list_foreach']"/>
+  <attr path="/api/namespace/struct[ cname='GMimeHeaderList']/method[ name='SetStream']" name="hidden">true</attr>
+  <attr path="/api/namespace/struct[ cname='GMimeHeaderList']/method[ name='GetStream']" name="hidden">true</attr>
   <attr path="/api/namespace/struct[ cname='GMimeHeaderList']/method[ name='HasRaw']" name="hidden">true</attr>
   <attr path="/api/namespace/struct[ cname='GMimeHeaderList']/method[ name='SetRaw']" name="hidden">true</attr>
   <attr path="/api/namespace/struct[ cname='GMimeHeaderList']/method[ name='Prepend']" name="name">PrependHeader</attr>
diff --git a/mono/gmime-api.raw b/mono/gmime-api.raw
index 7f8811e..11e1ead 100644
--- a/mono/gmime-api.raw
+++ b/mono/gmime-api.raw
@@ -2423,7 +2423,10 @@
           <parameter type="GMimeHeaderIter*" name="iter" />
         </parameters>
       </method>
-      <method name="HasRaw" cname="g_mime_header_list_has_raw">
+      <method name="GetStream" cname="g_mime_header_list_get_stream">
+        <return-type type="GMimeStream*" />
+      </method>
+      <method name="HasRaw" cname="g_mime_header_list_has_raw" deprecated="1">
         <return-type type="gboolean" />
       </method>
       <constructor cname="g_mime_header_list_new" />
@@ -2454,12 +2457,18 @@
           <parameter type="const-char*" name="value" />
         </parameters>
       </method>
-      <method name="SetRaw" cname="g_mime_header_list_set_raw">
+      <method name="SetRaw" cname="g_mime_header_list_set_raw" deprecated="1">
         <return-type type="void" />
         <parameters>
           <parameter type="const-char*" name="raw" />
         </parameters>
       </method>
+      <method name="SetStream" cname="g_mime_header_list_set_stream">
+        <return-type type="void" />
+        <parameters>
+          <parameter type="GMimeStream*" name="stream" />
+        </parameters>
+      </method>
       <method name="ToString" cname="g_mime_header_list_to_string">
         <return-type type="char*" />
       </method>



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