gmime r1346 - in trunk: . docs/reference gmime

[fejj svn gnome org]

Author: fejj
Date: Sun Jun  8 00:14:37 2008
New Revision: 1346
URL: http://svn.gnome.org/viewvc/gmime?rev=1346&view=rev

Log:
2008-06-07  Jeffrey Stedfast  <fejj novell com>

	* gmime/*.h: Finished documenting all of the structs. Now at 100%
	symbols documented! Woot!



Modified:
   trunk/ChangeLog
   trunk/docs/reference/gmime.hierarchy
   trunk/gmime/gmime-cipher-context.h
   trunk/gmime/gmime-content-type.h
   trunk/gmime/gmime-data-wrapper.h
   trunk/gmime/gmime-disposition.h
   trunk/gmime/gmime-encodings.h
   trunk/gmime/gmime-gpg-context.h
   trunk/gmime/gmime-parser.h
   trunk/gmime/gmime-session-simple.h
   trunk/gmime/gmime-session.h

Modified: trunk/docs/reference/gmime.hierarchy
==============================================================================
--- trunk/docs/reference/gmime.hierarchy	(original)
+++ trunk/docs/reference/gmime.hierarchy	Sun Jun  8 00:14:37 2008
@@ -36,4 +36,3 @@
     GMimeStreamMmap
     GMimeStreamNull
 GInterface
-  GTypePlugin

Modified: trunk/gmime/gmime-cipher-context.h
==============================================================================
--- trunk/gmime/gmime-cipher-context.h	(original)
+++ trunk/gmime/gmime-cipher-context.h	Sun Jun  8 00:14:37 2008
@@ -76,6 +76,17 @@
 	GMIME_CIPHER_HASH_HAVAL5160
 } GMimeCipherHash;
 
+
+/**
+ * GMimeCipherContext:
+ * @parent_object: parent #GObject
+ * @session: a #GMimeSession
+ * @sign_protocol: signature protocol (must be set by subclass)
+ * @encrypt_protocol: encryption protocol (must be set by subclass)
+ * @key_protocol: key exchange protocol (must be set by subclass)
+ *
+ * A crypto context for use with MIME.
+ **/
 struct _GMimeCipherContext {
 	GObject parent_object;
 	

Modified: trunk/gmime/gmime-content-type.h
==============================================================================
--- trunk/gmime/gmime-content-type.h	(original)
+++ trunk/gmime/gmime-content-type.h	Sun Jun  8 00:14:37 2008
@@ -27,15 +27,25 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GMimeContentType:
+ * @parent_object: parent object pointer
+ * @param_hash: parameter hash keyed by param name
+ * @params: a #GMimeParam list
+ * @type: media type
+ * @subtype: media subtype
+ *
+ * A data structure representing a Content-Type.
+ **/
 struct _GMimeContentType {
 	/* <private> */
 	gpointer parent_object;
 	GHashTable *param_hash;
 	
 	/* <public:read-only> */
+	GMimeParam *params;
 	char *type;
 	char *subtype;
-	GMimeParam *params;
 };
 
 typedef struct _GMimeContentType GMimeContentType;

Modified: trunk/gmime/gmime-data-wrapper.h
==============================================================================
--- trunk/gmime/gmime-data-wrapper.h	(original)
+++ trunk/gmime/gmime-data-wrapper.h	Sun Jun  8 00:14:37 2008
@@ -42,6 +42,15 @@
 typedef struct _GMimeDataWrapper GMimeDataWrapper;
 typedef struct _GMimeDataWrapperClass GMimeDataWrapperClass;
 
+
+/**
+ * GMimeDataWrapper:
+ * @parent_object: parent #GObject
+ * @encoding: the encoding of the content
+ * @stream: content stream
+ *
+ * A wrapper for a stream which may be encoded.
+ **/
 struct _GMimeDataWrapper {
 	GObject parent_object;
 	

Modified: trunk/gmime/gmime-disposition.h
==============================================================================
--- trunk/gmime/gmime-disposition.h	(original)
+++ trunk/gmime/gmime-disposition.h	Sun Jun  8 00:14:37 2008
@@ -44,14 +44,23 @@
 #define GMIME_DISPOSITION_INLINE     "inline"
 
 
+/**
+ * GMimeContentDisposition:
+ * @parent_object: parent object pointer
+ * @param_hash: parameter hash table keyed by param name
+ * @params: a #GMimeParam list
+ * @disposition: disposition
+ *
+ * A data structure representing a Content-Disposition.
+ **/
 struct _GMimeContentDisposition {
 	/* <private> */
 	gpointer parent_object;
 	GHashTable *param_hash;
 	
 	/* <public:read-only> */
-	char *disposition;
 	GMimeParam *params;
+	char *disposition;
 };
 
 typedef struct _GMimeContentDisposition GMimeContentDisposition;

Modified: trunk/gmime/gmime-encodings.h
==============================================================================
--- trunk/gmime/gmime-encodings.h	(original)
+++ trunk/gmime/gmime-encodings.h	Sun Jun  8 00:14:37 2008
@@ -121,6 +121,16 @@
 #define GMIME_UUDECODE_STATE_MASK   (GMIME_UUDECODE_STATE_BEGIN | GMIME_UUDECODE_STATE_END)
 
 
+/**
+ * GMimeEncoding:
+ * @encoding: the type of encoding
+ * @uubuf: a temporary buffer needed when uuencoding data
+ * @encode: %TRUE if encoding or %FALSE if decoding
+ * @save: saved bytes from the previous step
+ * @state: current encder/decoder state
+ *
+ * A context used for encoding or decoding data.
+ **/
 typedef struct _GMimeEncoding {
 	GMimeContentEncoding encoding;
 	unsigned char uubuf[60];

Modified: trunk/gmime/gmime-gpg-context.h
==============================================================================
--- trunk/gmime/gmime-gpg-context.h	(original)
+++ trunk/gmime/gmime-gpg-context.h	Sun Jun  8 00:14:37 2008
@@ -37,11 +37,18 @@
 typedef struct _GMimeGpgContextClass GMimeGpgContextClass;
 
 
+/**
+ * GMimeGpgContext:
+ * @parent_object: parent #GMimeCipherContext
+ * @always_trust: %TRUE if keys should always be trusted
+ * @path: path to gpg
+ *
+ * A GnuPG cipher context.
+ **/
 struct _GMimeGpgContext {
 	GMimeCipherContext parent_object;
-	
-	char *path;
 	gboolean always_trust;
+	char *path;
 };
 
 struct _GMimeGpgContextClass {

Modified: trunk/gmime/gmime-parser.h
==============================================================================
--- trunk/gmime/gmime-parser.h	(original)
+++ trunk/gmime/gmime-parser.h	Sun Jun  8 00:14:37 2008
@@ -43,6 +43,14 @@
 typedef struct _GMimeParser GMimeParser;
 typedef struct _GMimeParserClass GMimeParserClass;
 
+
+/**
+ * GMimeParser:
+ * @parent_object: parent #GObject
+ * @priv: private parser state
+ *
+ * A MIME parser context.
+ **/
 struct _GMimeParser {
 	GObject parent_object;
 	

Modified: trunk/gmime/gmime-session-simple.h
==============================================================================
--- trunk/gmime/gmime-session-simple.h	(original)
+++ trunk/gmime/gmime-session-simple.h	Sun Jun  8 00:14:37 2008
@@ -43,6 +43,17 @@
 typedef void (* GMimeSimpleForgetPasswdFunc) (GMimeSession *session, const char *item,
 					      GError **err);
 
+
+/**
+ * GMimeSessionSimple:
+ * @parent_object: parent #GMimeSession
+ * @is_online: callback to check network state
+ * @request_passwd: password-request callback
+ * @forget_passwd: callback to uncache a passwd
+ *
+ * A simple #GMimeSession for applications that don't want to
+ * implement their own #GMimeSession context.
+ **/
 struct _GMimeSessionSimple {
 	GMimeSession parent_object;
 	

Modified: trunk/gmime/gmime-session.h
==============================================================================
--- trunk/gmime/gmime-session.h	(original)
+++ trunk/gmime/gmime-session.h	Sun Jun  8 00:14:37 2008
@@ -37,6 +37,15 @@
 typedef struct _GMimeSession GMimeSession;
 typedef struct _GMimeSessionClass GMimeSessionClass;
 
+
+/**
+ * GMimeSession:
+ * @parent_object: parent #GObject
+ *
+ * An object used for interfacing with the user through the
+ * application. This object is meant to be subclassed by the
+ * application.
+ **/
 struct _GMimeSession {
 	GObject parent_object;