[gmime] updated gtk-doc comments and TODO



commit 80ecc285500dc7328507f6e24b8bc6369f60d3e3
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Mon Apr 27 10:49:09 2009 -0400

    updated gtk-doc comments and TODO
---
 TODO                      |    2 +-
 gmime/gmime-stream-file.c |   10 +++++-----
 gmime/gmime-stream-fs.c   |    2 +-
 gmime/gmime-stream-gio.c  |    6 +++---
 gmime/gmime-stream-mem.c  |    4 ++--
 gmime/gmime.c             |    4 ++--
 6 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/TODO b/TODO
index dac4e01..9933f0f 100644
--- a/TODO
+++ b/TODO
@@ -26,7 +26,7 @@ GMime 2.6 Planning:
 - Consider GCancellable and GError for GMimeStreams and
   GMimeParser... GError being far more important than GCancellable.
 
-- Add GIO-based GMimeStream and bump glib dep to 2.16
+- Add GIO-based GMimeStream and bump glib dep to 2.16 [ DONE ]
 
 - Add a g_mime_part_set_best_encoding()?
 
diff --git a/gmime/gmime-stream-file.c b/gmime/gmime-stream-file.c
index a4c5518..2fcb57c 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 c367779..5cc2e8b 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-gio.c b/gmime/gmime-stream-gio.c
index 79e9c82..3d38225 100644
--- a/gmime/gmime-stream-gio.c
+++ b/gmime/gmime-stream-gio.c
@@ -684,9 +684,9 @@ g_mime_stream_gio_new_with_bounds (GFile *file, gint64 start, gint64 end)
  * g_mime_stream_gio_get_owner:
  * @stream: a #GMimeStreamGIO stream
  *
- * Gets whether or not @stream owns the backend file descriptor.
+ * Gets whether or not @stream owns the backend #GFile.
  *
- * Returns: %TRUE if @stream owns the backend file descriptor or %FALSE
+ * Returns: %TRUE if @stream owns the backend #GFile or %FALSE
  * otherwise.
  **/
 gboolean
@@ -701,7 +701,7 @@ g_mime_stream_gio_get_owner (GMimeStreamGIO *stream)
 /**
  * g_mime_stream_gio_set_owner:
  * @stream: a #GMimeStreamGIO stream
- * @owner: owner
+ * @owner: %TRUE if this stream should own the #GFile or %FALSE otherwise
  *
  * Sets whether or not @stream owns the backend GIO pointer.
  *
diff --git a/gmime/gmime-stream-mem.c b/gmime/gmime-stream-mem.c
index d9c1cf9..6a63108 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/gmime/gmime.c b/gmime/gmime.c
index 9e1c26d..99c1c4a 100644
--- a/gmime/gmime.c
+++ b/gmime/gmime.c
@@ -44,8 +44,8 @@ GQuark gmime_error_quark;
 const guint gmime_major_version = GMIME_MAJOR_VERSION;
 const guint gmime_minor_version = GMIME_MINOR_VERSION;
 const guint gmime_micro_version = GMIME_MICRO_VERSION;
-const guint gmime_interface_age = 0;
-const guint gmime_binary_age = 0;
+const guint gmime_interface_age = GMIME_INTERFACE_AGE;
+const guint gmime_binary_age = GMIME_BINARY_AGE;
 
 static unsigned int initialized = 0;
 static guint32 enable = 0;



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