added gtk-doc comments
authorJeffrey Stedfast <fejj@src.gnome.org>
Fri, 15 Oct 2004 20:21:02 +0000 (20:21 +0000)
committerJeffrey Stedfast <fejj@src.gnome.org>
Fri, 15 Oct 2004 20:21:02 +0000 (20:21 +0000)
camel/providers/imap4/camel-imap4-stream.c

index 24a8285..f26c3c1 100644 (file)
@@ -604,7 +604,7 @@ camel_imap4_stream_unget_token (CamelIMAP4Stream *stream, camel_imap4_token_t *t
 
 
 /**
- * camel_imap4_stream_readline:
+ * camel_imap4_stream_line:
  * @stream: imap4 stream
  * @line: line pointer
  * @len: line length
@@ -661,6 +661,19 @@ camel_imap4_stream_line (CamelIMAP4Stream *stream, unsigned char **line, size_t
 }
 
 
+/**
+ * camel_imap4_stream_literal:
+ * @stream: IMAP stream
+ * @literal: literal pointer
+ * @len: literal length
+ *
+ * Sets @literal to the beginning of the next chunk of the literal
+ * buffer from the IMAP stream and sets @len to the length of the
+ * @literal buffer.
+ *
+ * Returns >0 if more literal data exists, 0 if the end of the literal
+ * has been reached or -1 on fail.
+ **/
 int
 camel_imap4_stream_literal (CamelIMAP4Stream *stream, unsigned char **literal, size_t *len)
 {