Clean, polish, document. Most of the gtk-doc comments added to

	* camel-data-wrapper.[ch]:
	* camel-simple-data-wrapper.[ch]:
	* camel-medium.[ch]: Clean, polish, document. Most of the gtk-doc
	comments added to camel-data-wrapper.c note serious problems that
	need to be fixed.

svn path=/trunk/; revision=2483

1 files changed, 28 insertions, 17 deletions

diff --git a/camel/camel-medium.h b/camel/camel-medium.h
index ce3bb9983b..0e34f1c2a7 100644
--- a/camel/camel-medium.h
+++ b/camel/camel-medium.h
@@ -1,15 +1,15 @@
 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
 /* camel-medium.h : class for a medium object */
 
-/* 
+/*
  *
- * Author : 
+ * Author :
  *  Bertrand Guiheneuf <bertrand@helixcode.com>
  *
  * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
  *
- * This program is free software; you can redistribute it and/or 
- * modify it under the terms of the GNU General Public License as 
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
  *
@@ -47,25 +47,32 @@ extern "C" {
 struct _CamelMedium
 {
 	CamelDataWrapper parent_object;
-	
+
 	GHashTable *headers;
-	
-	CamelDataWrapper *content; /* part real content */
-	
+
+	/* The content of the medium, as opposed to our parent
+	 * CamelDataWrapper, which wraps both the headers and the
+	 * content.
+	 */
+	CamelDataWrapper *content;
+
 };
 
 
 
 typedef struct {
 	CamelDataWrapperClass parent_class;
-	
-	/* Virtual methods */	
-	void  (*add_header) (CamelMedium *medium, gchar *header_name, gchar *header_value);
+
+	/* Virtual methods */
+	void  (*add_header) (CamelMedium *medium, gchar *header_name,
+			     gchar *header_value);
 	void  (*remove_header) (CamelMedium *medium, const gchar *header_name);
-	const gchar * (*get_header) (CamelMedium *medium, const gchar *header_name);
+	const gchar * (*get_header) (CamelMedium *medium,
+				     const gchar *header_name);
 
 	CamelDataWrapper * (*get_content_object) (CamelMedium *medium);
-	void (*set_content_object) (CamelMedium *medium, CamelDataWrapper *content);
+	void (*set_content_object) (CamelMedium *medium,
+				    CamelDataWrapper *content);
 
 } CamelMediumClass;
 
@@ -76,13 +83,17 @@ GtkType camel_medium_get_type (void);
 
 
 /* public methods */
-void camel_medium_add_header (CamelMedium *medium, gchar *header_name, gchar *header_value);
-void camel_medium_remove_header (CamelMedium *medium, const gchar *header_name);
-const gchar *camel_medium_get_header (CamelMedium *medium, const gchar *header_name);
+void camel_medium_add_header (CamelMedium *medium, gchar *header_name,
+			      gchar *header_value);
+void camel_medium_remove_header (CamelMedium *medium,
+				 const gchar *header_name);
+const gchar *camel_medium_get_header (CamelMedium *medium,
+				      const gchar *header_name);
 
 
 CamelDataWrapper *camel_medium_get_content_object (CamelMedium *medium);
-void camel_medium_set_content_object (CamelMedium *medium, CamelDataWrapper *content);
+void camel_medium_set_content_object (CamelMedium *medium,
+				      CamelDataWrapper *content);
 
 
 #ifdef __cplusplus