A first attempt at setting up the documentation system.

svn path=/trunk/; revision=862

7 files changed, 18 insertions, 11 deletions

diff --git a/Makefile.am b/Makefile.am
index 0958d2dcc2..8c71d15d79 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = po macros camel
+SUBDIRS = po macros camel devel-docs
 
 
 
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 8e0660c160..12c2d02db0 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -245,6 +245,7 @@ camel_folder_is_open(CamelFolder *folder)
  * It is an error to ask a folder begining with the 
  * folder separator character.  
  * 
+ * @folder : the folder
  * @folderName: subfolder path. NULL if the subfolder object
  *        could not be created
  **/
diff --git a/camel/camel-service.c b/camel/camel-service.c
index 4bcbe7088b..dd909cbb1f 100644
--- a/camel/camel-service.c
+++ b/camel/camel-service.c
@@ -28,7 +28,6 @@ static GtkObjectClass *camel_service_parent_class=NULL;
 /* Returns the class for a CamelService */
 #define CSERV_CLASS(so) CAMEL_SERVICE_CLASS (GTK_OBJECT(so)->klass)
 
-static void camel_service_connect(CamelService *service);
 static void camel_service_connect_to_with_login_passwd(CamelService *service, GString *host, GString *login, GString *passwd);
 static void camel_service_connect_to_with_login_passwd_port(CamelService *service, GString *host, GString *login, GString *passwd, guint port);
 static gboolean camel_service_is_connected(CamelService *service);
@@ -102,7 +101,7 @@ camel_service_connect(CamelService *service)
 
 
 /**
- * camel_service_connect_to:login:password : connect to the specified address
+ * camel_service_connect_to: connect to the specified address
  * 
  * Connect to the service, but do not use the session
  * default parameters to retrieve server's address
diff --git a/camel/camel-service.h b/camel/camel-service.h
index ebb6464a3e..080895a083 100644
--- a/camel/camel-service.h
+++ b/camel/camel-service.h
@@ -65,6 +65,7 @@ typedef struct {
 
 
 /* public methods */
+void camel_service_connect(CamelService *service);
 
 /* Standard Gtk function */
 GtkType camel_service_get_type (void);
diff --git a/camel/camel-store.c b/camel/camel-store.c
index dc29e0a8ae..d3f693ad93 100644
--- a/camel/camel-store.c
+++ b/camel/camel-store.c
@@ -29,7 +29,6 @@ static GtkObjectClass *camel_store_parent_class=NULL;
 #define CS_CLASS(so) CAMEL_STORE_CLASS (GTK_OBJECT(so)->klass)
 
 static void camel_store_set_separator(CamelStore *store, gchar sep);
-static gchar camel_store_get_geparator(CamelStore *store);
 static CamelFolder *camel_store_get_root_folder(CamelStore *store);
 static CamelFolder *camel_store_get_default_folder(CamelStore *store);
 
@@ -42,7 +41,7 @@ camel_store_class_init (CamelStoreClass *camel_store_class)
 	
 	/* virtual method definition */
 	camel_store_class->set_separator = camel_store_set_separator;
-	camel_store_class->get_separator = camel_store_get_geparator;
+	camel_store_class->get_separator = camel_store_get_separator;
 	camel_store_class->get_folder = camel_store_get_folder;
 	camel_store_class->get_root_folder = camel_store_get_root_folder;
 	camel_store_class->get_default_folder = camel_store_get_default_folder;
@@ -87,7 +86,8 @@ camel_store_get_type (void)
  * camel_store_set_separator: set the character which separates this folder 
  * path from the folders names in a lower level of hierarchy.
  *
- * 
+ * @store:
+ * @sep:
  *
  **/
 static void
@@ -102,11 +102,11 @@ camel_store_set_separator(CamelStore *store, gchar sep)
  * camel_store_get_separator: return the character which separates this folder 
  * path from the folders names in a lower level of hierarchy.
  *
- * 
+ * @store: store
  *
  **/
-static gchar
-camel_store_get_geparator(CamelStore *store)
+gchar
+camel_store_get_separator(CamelStore *store)
 {
 	g_assert(store);
 	return store->separator;
@@ -127,9 +127,12 @@ camel_store_get_geparator(CamelStore *store)
  * If it does not exist, you can create it with its 
  * "create" method.
  *
- * @Return value: the folder
+ * @store: store
+ * @folder_name: name of the folder to get
+ *
+ * Return value: the folder
  **/
-static CamelFolder *
+CamelFolder *
 camel_store_get_folder(CamelStore *store, GString *folder_name)
 {
 
diff --git a/camel/camel-store.h b/camel/camel-store.h
index 15fbbe6301..d2180b89be 100644
--- a/camel/camel-store.h
+++ b/camel/camel-store.h
@@ -77,6 +77,7 @@ typedef struct {
 GtkType camel_store_get_type (void);
 
 CamelFolder *camel_store_get_folder(CamelStore *store, GString *folder_name);
+gchar camel_store_get_separator(CamelStore *store);
 
 #ifdef __cplusplus
 }
diff --git a/configure.in b/configure.in
index 0ef78811b2..a796bee15f 100644
--- a/configure.in
+++ b/configure.in
@@ -46,4 +46,6 @@ Makefile
 macros/Makefile
 po/Makefile.in
 camel/Makefile
+devel-docs/Makefile
+devel-docs/camel/Makefile
 ])