gmime r1340 - trunk/gmime

[fejj svn gnome org]

Author: fejj
Date: Sat Jun  7 03:18:23 2008
New Revision: 1340
URL: http://svn.gnome.org/viewvc/gmime?rev=1340&view=rev

Log:
added more gtk-doc comments for classes

Modified:
   trunk/gmime/gmime-filter-basic.h
   trunk/gmime/gmime-filter-best.h
   trunk/gmime/gmime-filter-charset.h
   trunk/gmime/gmime-filter-crlf.h
   trunk/gmime/gmime-filter-enriched.h
   trunk/gmime/gmime-filter-from.h
   trunk/gmime/gmime-filter-gzip.h
   trunk/gmime/gmime-filter-html.h
   trunk/gmime/gmime-filter-md5.h
   trunk/gmime/gmime-filter-strip.h
   trunk/gmime/gmime-filter-windows.h
   trunk/gmime/gmime-filter-yenc.h

Modified: trunk/gmime/gmime-filter-basic.h
==============================================================================
--- trunk/gmime/gmime-filter-basic.h	(original)
+++ trunk/gmime/gmime-filter-basic.h	Sat Jun  7 03:18:23 2008
@@ -37,6 +37,13 @@
 typedef struct _GMimeFilterBasic GMimeFilterBasic;
 typedef struct _GMimeFilterBasicClass GMimeFilterBasicClass;
 
+/**
+ * GMimeFilterBasic:
+ * @parent_object: parent #GMimeFilter
+ * @encoder: #GMimeEncoding state
+ *
+ * A basic encoder/decoder filter for the MIME encodings.
+ **/
 struct _GMimeFilterBasic {
 	GMimeFilter parent_object;
 	GMimeEncoding encoder;

Modified: trunk/gmime/gmime-filter-best.h
==============================================================================
--- trunk/gmime/gmime-filter-best.h	(original)
+++ trunk/gmime/gmime-filter-best.h	Sat Jun  7 03:18:23 2008
@@ -70,6 +70,26 @@
 	GMIME_BEST_ENCODING_BINARY
 } GMimeBestEncoding;
 
+
+/**
+ * GMimeFilterBest:
+ * @parent_object: parent #GMimeFilter
+ * @flags: #GMimeFilterBestFlags
+ * @charset: #GMimeCharset state
+ * @count0: count of nul-bytes passed through the filter
+ * @count8: count of 8bit bytes passed through the filter
+ * @total: total number of bytes passed through the filter
+ * @maxline: the length of the longest line passed through the filter
+ * @linelen: current line length
+ * @frombuf: buffer for checking From_ lines
+ * @fromlen: length of bytes in @frombuf
+ * @hadfrom: %TRUE if any line started with "From "
+ * @startline: start line state
+ * @midline: mid-line state
+ *
+ * A filter for calculating the best encoding and/or charset to encode
+ * the data passed through it.
+ **/
 struct _GMimeFilterBest {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-charset.h
==============================================================================
--- trunk/gmime/gmime-filter-charset.h	(original)
+++ trunk/gmime/gmime-filter-charset.h	Sat Jun  7 03:18:23 2008
@@ -37,6 +37,15 @@
 typedef struct _GMimeFilterCharset GMimeFilterCharset;
 typedef struct _GMimeFilterCharsetClass GMimeFilterCharsetClass;
 
+/**
+ * GMimeFilterCharset:
+ * @parent_object: parent #GMimeFilter
+ * @from_charset: charset that the filter is converting from
+ * @to_charset: charset the filter is converting to
+ * @cd: charset conversion state
+ *
+ * A filter to convert between charsets.
+ **/
 struct _GMimeFilterCharset {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-crlf.h
==============================================================================
--- trunk/gmime/gmime-filter-crlf.h	(original)
+++ trunk/gmime/gmime-filter-crlf.h	Sat Jun  7 03:18:23 2008
@@ -36,6 +36,17 @@
 typedef struct _GMimeFilterCRLF GMimeFilterCRLF;
 typedef struct _GMimeFilterCRLFClass GMimeFilterCRLFClass;
 
+/**
+ * GMimeFilterCRLF:
+ * @parent_object: parent #GMimeFilter
+ * @encode: encoding vs decoding line endings/dots
+ * @saw_cr: previous char was a CR
+ * @saw_ld: previous char was a LF
+ * @saw_dot: previous char was a period
+ *
+ * A filter to convert between line-ending formats and encode/decode
+ * lines beginning with a '.'.
+ **/
 struct _GMimeFilterCRLF {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-enriched.h
==============================================================================
--- trunk/gmime/gmime-filter-enriched.h	(original)
+++ trunk/gmime/gmime-filter-enriched.h	Sat Jun  7 03:18:23 2008
@@ -45,6 +45,15 @@
  **/
 #define GMIME_FILTER_ENRICHED_IS_RICHTEXT  (1 << 0)
 
+/**
+ * GMimeFilterEnriched:
+ * @parent_object: parent #GMimeFilter
+ * @flags: bit flags
+ * @nofill: nofill tag state
+ *
+ * A filter for converting text/enriched or text/richtext textual
+ * streams into text/html.
+ **/
 struct _GMimeFilterEnriched {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-from.h
==============================================================================
--- trunk/gmime/gmime-filter-from.h	(original)
+++ trunk/gmime/gmime-filter-from.h	Sat Jun  7 03:18:23 2008
@@ -52,6 +52,14 @@
 } GMimeFilterFromMode;
 
 
+/**
+ * GMimeFilterFrom:
+ * @parent_object: parent #GMimeFilter
+ * @mode: #GMimeFilterFromMode
+ * @midline: %TRUE if in the middle of a line
+ *
+ * A filter for armoring or escaping lines beginning with "From ".
+ **/
 struct _GMimeFilterFrom {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-gzip.h
==============================================================================
--- trunk/gmime/gmime-filter-gzip.h	(original)
+++ trunk/gmime/gmime-filter-gzip.h	Sat Jun  7 03:18:23 2008
@@ -50,6 +50,15 @@
 } GMimeFilterGZipMode;
 
 
+/**
+ * GMimeFilterGZip:
+ * @parent_object: parent #GMimeFilter
+ * @priv: private state data
+ * @mode: #GMimeFilterGZipMode
+ * @level: compression level
+ *
+ * A filter for compresing or decompressing a gzip stream.
+ **/
 struct _GMimeFilterGZip {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-html.h
==============================================================================
--- trunk/gmime/gmime-filter-html.h	(original)
+++ trunk/gmime/gmime-filter-html.h	Sat Jun  7 03:18:23 2008
@@ -102,6 +102,17 @@
 #define GMIME_FILTER_HTML_CITE              (1 << 7)
 
 
+/**
+ * GMimeFilterHTML:
+ * @parent_object: parent #GMimeFilter
+ * @scanner: URL scanner state
+ * @flags: flags specifying HTML conversion rules
+ * @colour: cite colour
+ * @column: current column
+ * @pre_open: currently inside of a 'pre' tag.
+ *
+ * A filter for converting text/plain into text/html.
+ **/
 struct _GMimeFilterHTML {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-md5.h
==============================================================================
--- trunk/gmime/gmime-filter-md5.h	(original)
+++ trunk/gmime/gmime-filter-md5.h	Sat Jun  7 03:18:23 2008
@@ -36,6 +36,13 @@
 typedef struct _GMimeFilterMd5 GMimeFilterMd5;
 typedef struct _GMimeFilterMd5Class GMimeFilterMd5Class;
 
+/**
+ * GMimeFilterMd5:
+ * @parent_object: parent #GMimeFilter
+ * @priv: private state data
+ *
+ * A filter for calculating the MD5 checksum of a stream.
+ **/
 struct _GMimeFilterMd5 {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-strip.h
==============================================================================
--- trunk/gmime/gmime-filter-strip.h	(original)
+++ trunk/gmime/gmime-filter-strip.h	Sat Jun  7 03:18:23 2008
@@ -36,6 +36,12 @@
 typedef struct _GMimeFilterStrip GMimeFilterStrip;
 typedef struct _GMimeFilterStripClass GMimeFilterStripClass;
 
+/**
+ * GMimeFilterStrip:
+ * @parent_object: parent #GMimeFilter
+ *
+ * A filter for stripping whitespace from the end of lines.
+ **/
 struct _GMimeFilterStrip {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-windows.h
==============================================================================
--- trunk/gmime/gmime-filter-windows.h	(original)
+++ trunk/gmime/gmime-filter-windows.h	Sat Jun  7 03:18:23 2008
@@ -36,6 +36,16 @@
 typedef struct _GMimeFilterWindows GMimeFilterWindows;
 typedef struct _GMimeFilterWindowsClass GMimeFilterWindowsClass;
 
+/**
+ * GMimeFilterWindows:
+ * @parent_object: parent #GMimeFilter
+ * @is_windows: %TRUE if the stream is detected to be a windows-cp125x charset
+ * @claimed_charset: charset the text stream is claimed to be
+ *
+ * A filter for detecting whether or not a text stream claimed to be
+ * iso-8859-X is really that charset or if it is really a
+ * Windows-CP125x charset.
+ **/
 struct _GMimeFilterWindows {
 	GMimeFilter parent_object;
 	

Modified: trunk/gmime/gmime-filter-yenc.h
==============================================================================
--- trunk/gmime/gmime-filter-yenc.h	(original)
+++ trunk/gmime/gmime-filter-yenc.h	Sat Jun  7 03:18:23 2008
@@ -121,6 +121,17 @@
  **/
 #define GMIME_YENCODE_CRC_FINAL(crc) (~crc)
 
+/**
+ * GMimeFilterYenc:
+ * @parent_object: parent #GMimeFilter
+ * @encode: encode vs decode
+ * @part: part id
+ * @state: encode/decode state
+ * @pcrc: part crc
+ * @crc: full crc
+ *
+ * A filter for yEncoding or yDecoding a stream.
+ **/
 struct _GMimeFilterYenc {
 	GMimeFilter parent_object;