[prev in list] [next in list] [prev in thread] [next in thread] 

List:       gnupg-commit-watchers
Subject:    [gnutls-commits] CVS opencdk/src
From:       "CVS User twoaday" <twoaday () gnutls ! org>
Date:       2007-11-24 14:33:17
Message-ID: E1Ivw4L-0008Se-G8 () trithemius ! gnupg ! org
[Download RAW message or body]

Update of /cvs/gnutls/opencdk/src
In directory trithemius:/tmp/cvs-serv32513

Modified Files:
	stream.c 
Log Message:
Work on consistent gdoc headers.


--- /cvs/gnutls/opencdk/src/stream.c	2007/11/08 18:31:28	1.93
+++ /cvs/gnutls/opencdk/src/stream.c	2007/11/24 14:33:17	1.94
@@ -53,7 +53,7 @@
  * @file: The file to open
  * @ret_s: The new STREAM object
  * 
- * Create a new stream based on an existing file. The stream is
+ * Creates a new stream based on an existing file. The stream is
  * opened in read-only mode.
  **/
 cdk_error_t
@@ -137,9 +137,11 @@
 
 
 /**
- * cdk_stream_new: Create a new stream into into the given file.
+ * cdk_stream_new: 
  * @file: The name of the new file
  * @ret_s: The new STREAM object
+ * 
+ * Create a new stream into into the given file.
  **/
 cdk_error_t
 cdk_stream_new (const char *file, cdk_stream_t *ret_s)
@@ -180,10 +182,11 @@
 
 
 /**
- * cdk_stream_create: create a new stream.
+ * cdk_stream_create: 
  * @file: the filename
  * @ret_s: the object
  *
+ * Creates a new stream.
  * The difference to cdk_stream_new is, that no filtering can be used with
  * this kind of stream and everything is written directly to the stream.
  **/
@@ -225,7 +228,7 @@
  * cdk_stream_tmp_new:
  * @r_out: the new temp stream.
  * 
- * Allocate a new tempory stream which is not associated with a file.
+ * Allocates a new tempory stream which is not associated with a file.
  */
 cdk_error_t
 cdk_stream_tmp_new (cdk_stream_t *r_out)
@@ -241,7 +244,7 @@
  * @buflen: how large the buffer is
  * @r_out: the new stream with the given contents.
  * 
- * Create a new tempory stream with the given contests.
+ * Creates a new tempory stream with the given contests.
  */
 cdk_error_t
 cdk_stream_tmp_from_mem (const void *buf, size_t buflen, cdk_stream_t *r_out)
@@ -313,7 +316,7 @@
  * cdk_stream_is_compressed:
  * @s: the stream
  * 
- * Return 0 if the stream is uncompressed, otherwise the
+ * Returns 0 if the stream is uncompressed, otherwise the
  * compression algorithm.
  */
 int
@@ -622,10 +625,11 @@
 
 
 /**
- * cdk_stream_filter_disable: Disable the filter with the type 'type'
+ * cdk_stream_filter_disable: 
  * @s: The STREAM object
  * @type: The numberic filter ID.
  *
+ * Disables the filter with the type 'type'.
  **/
 cdk_error_t
 cdk_stream_filter_disable (cdk_stream_t s, int type)
@@ -810,11 +814,12 @@
 
 
 /**
- * cdk_stream_read: Try to read count bytes from the STREAM object.
+ * cdk_stream_read: 
  * @s: The STREAM object.
  * @buf: The buffer to insert the readed bytes.
  * @count: Request so much bytes.
  *
+ * Tries to read count bytes from the STREAM object.
  * When this function is called the first time, it can take a while
  * because all filters need to be processed. Please remember that you
  * need to add the filters in reserved order.
@@ -892,11 +897,12 @@
 
 
 /**
- * cdk_stream_write: Try to write count bytes into the stream.
+ * cdk_stream_write: 
  * @s: The STREAM object
  * @buf: The buffer with the values to write.
  * @count: The size of the buffer.
  *
+ * Tries to write count bytes into the stream.
  * In this function we simply write the bytes to the stream. We can't
  * use the filters here because it would mean they have to support
  * partial flushing.
@@ -1207,7 +1213,7 @@
  * @s: the stream object
  * @val: 1=on, 0=off
  *
- * Enable or disable the cache section of a stream object.
+ * Enables or disable the cache section of a stream object.
  **/
 cdk_error_t
 cdk_stream_enable_cache (cdk_stream_t s, int val)
@@ -1292,7 +1298,7 @@
  * @ret_buf: the buffer to store the content
  * @ret_buflen: length of the buffer
  *
- * Map the data of the given stream into a memory section. @ret_count
+ * Maps the data of the given stream into a memory section. @ret_count
  * contains the length of the buffer.
  **/
 cdk_error_t


_______________________________________________
Gnutls-commits mailing list
Gnutls-commits@gnupg.org
http://lists.gnupg.org/mailman/listinfo/gnutls-commits
[prev in list] [next in list] [prev in thread] [next in thread]