gmime r1488 - trunk/gmime

[fejj svn gnome org]

Author: fejj
Date: Sat Oct  4 01:34:30 2008
New Revision: 1488
URL: http://svn.gnome.org/viewvc/gmime?rev=1488&view=rev

Log:
updated docs

Modified:
   trunk/gmime/gmime-stream-cat.c
   trunk/gmime/gmime-stream.c

Modified: trunk/gmime/gmime-stream-cat.c
==============================================================================
--- trunk/gmime/gmime-stream-cat.c	(original)
+++ trunk/gmime/gmime-stream-cat.c	Sat Oct  4 01:34:30 2008
@@ -673,9 +673,9 @@
 /**
  * g_mime_stream_cat_new:
  *
- * Creates a new GMimeStreamCat object.
+ * Creates a new #GMimeStreamCat object.
  *
- * Returns: a new cat stream.
+ * Returns: a new #GMimeStreamCat stream.
  **/
 GMimeStream *
 g_mime_stream_cat_new (void)
@@ -691,10 +691,10 @@
 
 /**
  * g_mime_stream_cat_add_source:
- * @cat: cat stream
+ * @cat: a #GMimeStreamCat
  * @source: a source stream
  *
- * Adds the @source stream to the cat stream @cat.
+ * Adds the @source stream to the @cat.
  *
  * Returns: %0 on success or %-1 on fail.
  **/

Modified: trunk/gmime/gmime-stream.c
==============================================================================
--- trunk/gmime/gmime-stream.c	(original)
+++ trunk/gmime/gmime-stream.c	Sat Oct  4 01:34:30 2008
@@ -133,7 +133,7 @@
 
 /**
  * g_mime_stream_construct:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @start: start boundary
  * @end: end boundary
  *
@@ -158,7 +158,7 @@
 
 /**
  * g_mime_stream_read:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @buf: buffer
  * @len: buffer length
  *
@@ -189,7 +189,7 @@
 
 /**
  * g_mime_stream_write:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @buf: buffer
  * @len: buffer length
  *
@@ -220,7 +220,7 @@
 
 /**
  * g_mime_stream_flush:
- * @stream: stream
+ * @stream: a #GMimeStream
  *
  * Sync's the stream to disk.
  *
@@ -245,7 +245,7 @@
 
 /**
  * g_mime_stream_close:
- * @stream: stream
+ * @stream: a #GMimeStream
  *
  * Closes the stream.
  *
@@ -270,7 +270,7 @@
 
 /**
  * g_mime_stream_eos:
- * @stream: stream
+ * @stream: a #GMimeStream
  *
  * Tests the end-of-stream indicator for @stream.
  *
@@ -298,7 +298,7 @@
 
 /**
  * g_mime_stream_reset:
- * @stream: stream
+ * @stream: a #GMimeStream
  *
  * Resets the stream.
  *
@@ -328,7 +328,7 @@
 
 /**
  * g_mime_stream_seek:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @offset: positional offset
  * @whence: seek directive
  *
@@ -366,7 +366,7 @@
 
 /**
  * g_mime_stream_tell:
- * @stream: stream
+ * @stream: a #GMimeStream
  *
  * Gets the current offset within the stream.
  *
@@ -402,7 +402,7 @@
 
 /**
  * g_mime_stream_length:
- * @stream: stream
+ * @stream: a #GMimeStream
  *
  * Gets the length of the stream.
  *
@@ -427,7 +427,7 @@
 
 /**
  * g_mime_stream_substream:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @start: start boundary
  * @end: end boundary
  *
@@ -453,7 +453,7 @@
 
 /**
  * g_mime_stream_set_bounds:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @start: start boundary
  * @end: end boundary
  *
@@ -476,7 +476,7 @@
 
 /**
  * g_mime_stream_write_string:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @str: string to write
  *
  * Writes @string to @stream.
@@ -489,13 +489,13 @@
 	g_return_val_if_fail (GMIME_IS_STREAM (stream), -1);
 	g_return_val_if_fail (str != NULL, -1);
 	
-	return g_mime_stream_write (stream, (char *) str, strlen (str));
+	return g_mime_stream_write (stream, str, strlen (str));
 }
 
 
 /**
  * g_mime_stream_printf:
- * @stream: stream
+ * @stream: a #GMimeStream
  * @fmt: format
  * @Varargs: arguments
  *
@@ -532,7 +532,7 @@
  * @src: source stream
  * @dest: destination stream
  *
- * Attempts to write stream @src to stream @dest.
+ * Attempts to write the source stream to the destination stream.
  *
  * Returns: the number of bytes written or %-1 on fail.
  **/
@@ -570,8 +570,8 @@
 
 /**
  * g_mime_stream_writev:
- * @stream: stream
- * @vector: i/o vector
+ * @stream: a #GMimeStream
+ * @vector: a #GMimeStreamIOVector
  * @count: number of vector elements
  *
  * Writes at most @count blocks described by @vector to @stream.