gmime r1489 - trunk/gmime

[fejj svn gnome org]

Author: fejj
Date: Sun Oct  5 00:33:21 2008
New Revision: 1489
URL: http://svn.gnome.org/viewvc/gmime?rev=1489&view=rev

Log:
updated docs

Modified:
   trunk/gmime/gmime-stream-file.c
   trunk/gmime/gmime-stream-filter.c
   trunk/gmime/gmime-stream-filter.h
   trunk/gmime/gmime-stream-fs.c

Modified: trunk/gmime/gmime-stream-file.c
==============================================================================
--- trunk/gmime/gmime-stream-file.c	(original)
+++ trunk/gmime/gmime-stream-file.c	Sun Oct  5 00:33:21 2008
@@ -315,9 +315,9 @@
  * g_mime_stream_file_new:
  * @fp: file pointer
  *
- * Creates a new GMimeStreamFile object around @fp.
+ * Creates a new #GMimeStreamFile object around @fp.
  *
- * Note: The created GMimeStreamFile object will own the FILE pointer
+ * Note: The created #GMimeStreamFile object will own the FILE pointer
  * passed in.
  *
  * Returns: a stream using @fp.
@@ -346,10 +346,10 @@
  * @start: start boundary
  * @end: end boundary
  *
- * Creates a new GMimeStreamFile object around @fp with bounds @start
+ * Creates a new #GMimeStreamFile object around @fp with bounds @start
  * and @end.
  *
- * Note: The created GMimeStreamFile object will own the FILE pointer
+ * Note: The created #GMimeStreamFile object will own the FILE pointer
  * passed in.
  *
  * Returns: a stream using @fp with bounds @start and @end.

Modified: trunk/gmime/gmime-stream-filter.c
==============================================================================
--- trunk/gmime/gmime-stream-filter.c	(original)
+++ trunk/gmime/gmime-stream-filter.c	Sun Oct  5 00:33:21 2008
@@ -428,25 +428,26 @@
 
 /**
  * g_mime_stream_filter_add:
- * @fstream: filter stream
- * @filter: filter
+ * @stream: a #GMimeStreamFilter
+ * @filter: a #GMimeFilter
  *
- * Adds a @filter to @fstream.
+ * Adds @filter to @stream. Filters are applied in the same order in
+ * which they are added.
  *
  * Returns: an id for the filter.
  **/
 int
-g_mime_stream_filter_add (GMimeStreamFilter *fstream, GMimeFilter *filter)
+g_mime_stream_filter_add (GMimeStreamFilter *stream, GMimeFilter *filter)
 {
 	struct _GMimeStreamFilterPrivate *priv;
 	struct _filter *f, *fn;
 	
-	g_return_val_if_fail (GMIME_IS_STREAM_FILTER (fstream), -1);
+	g_return_val_if_fail (GMIME_IS_STREAM_FILTER (stream), -1);
 	g_return_val_if_fail (GMIME_IS_FILTER (filter), -1);
 	
 	g_object_ref (filter);
 	
-	priv = fstream->priv;
+	priv = stream->priv;
 	
 	fn = g_new (struct _filter, 1);
 	fn->next = NULL;
@@ -466,21 +467,21 @@
 
 /**
  * g_mime_stream_filter_remove:
- * @fstream: filter stream
+ * @stream: a #GMimeStreamFilter
  * @id: filter id
  *
  * Removed a filter from the stream based on the id (as returned from
  * filter_add).
  **/
 void
-g_mime_stream_filter_remove (GMimeStreamFilter *fstream, int id)
+g_mime_stream_filter_remove (GMimeStreamFilter *stream, int id)
 {
 	struct _GMimeStreamFilterPrivate *priv;
 	struct _filter *f, *fn;
 	
-	g_return_if_fail (GMIME_IS_STREAM_FILTER (fstream));
+	g_return_if_fail (GMIME_IS_STREAM_FILTER (stream));
 	
-	priv = fstream->priv;
+	priv = stream->priv;
 	
 	if (id == -1)
 		return;

Modified: trunk/gmime/gmime-stream-filter.h
==============================================================================
--- trunk/gmime/gmime-stream-filter.h	(original)
+++ trunk/gmime/gmime-stream-filter.h	Sun Oct  5 00:33:21 2008
@@ -63,8 +63,8 @@
 
 GMimeStream *g_mime_stream_filter_new (GMimeStream *stream);
 
-int g_mime_stream_filter_add (GMimeStreamFilter *fstream, GMimeFilter *filter);
-void g_mime_stream_filter_remove (GMimeStreamFilter *fstream, int id);
+int g_mime_stream_filter_add (GMimeStreamFilter *stream, GMimeFilter *filter);
+void g_mime_stream_filter_remove (GMimeStreamFilter *stream, int id);
 
 G_END_DECLS
 

Modified: trunk/gmime/gmime-stream-fs.c
==============================================================================
--- trunk/gmime/gmime-stream-fs.c	(original)
+++ trunk/gmime/gmime-stream-fs.c	Sun Oct  5 00:33:21 2008
@@ -32,7 +32,7 @@
 
 
 #ifndef HAVE_FSYNC
-int fsync (int fd) { return 0; }
+static int fsync (int fd) { return 0; }
 #endif
 
 
@@ -361,7 +361,7 @@
  * g_mime_stream_fs_new:
  * @fd: file descriptor
  *
- * Creates a new GMimeStreamFs object around @fd.
+ * Creates a new #GMimeStreamFs object around @fd.
  *
  * Returns: a stream using @fd.
  **/
@@ -390,7 +390,7 @@
  * @start: start boundary
  * @end: end boundary
  *
- * Creates a new GMimeStreamFs object around @fd with bounds @start
+ * Creates a new #GMimeStreamFs object around @fd with bounds @start
  * and @end.
  *
  * Returns: a stream using @fd with bounds @start and @end.