* Added some unit tests for ModestTextUtils
[modest] / src / modest-tny-platform-factory.h
index d7368e8..3686cfb 100644 (file)
@@ -37,6 +37,7 @@
 #include <tny-platform-factory.h>
 #include "modest-account-mgr.h"
 #include "modest-conf.h"
+#include "modest-mail-operation-queue.h"
 
 G_BEGIN_DECLS
 
@@ -62,11 +63,53 @@ struct _ModestTnyPlatformFactoryClass {
 /* member functions */
 GType        modest_tny_platform_factory_get_type    (void) G_GNUC_CONST;
 
+/**
+ * modest_tny_platform_factory_get_instance:
+ * @void: 
+ * 
+ * Gets a new instance of the platform factory if it is the first call
+ * to the function, or the current one otherwise. This object is
+ * supposed to be a singleton
+ * 
+ * Returns: the instance of a #ModestTnyPlatformFactory
+ **/
 TnyPlatformFactory*    modest_tny_platform_factory_get_instance         (void);
 
-ModestAccountMgr*    modest_tny_platform_factory_get_modest_account_mgr_instance (TnyPlatformFactory *fact);
-ModestConf*          modest_tny_platform_factory_get_modest_conf_instance (TnyPlatformFactory *fact);
+/**
+ * modest_tny_platform_factory_get_modest_account_mgr_instance:
+ * @fact: the #TnyPlatformFactory that holds the #ModestAccountMgr instance
+ * 
+ * Gets a new instance of a #ModestAccountMgr if it is the first call
+ * to the function, or the current instantiated one otherwise. This
+ * object is supposed to be a singleton
+ * 
+ * Returns: an instance of a #ModestAccountMgr
+ **/
+ModestAccountMgr*  modest_tny_platform_factory_get_modest_account_mgr_instance (TnyPlatformFactory *fact);
 
+/**
+ * modest_tny_platform_factory_get_modest_conf_instance:
+ * @fact: the #TnyPlatformFactory that holds the #ModestConf instance
+ * 
+ * Gets a new instance of a #ModestConf if it is the first call to the
+ * function, or the current instantiated one otherwise. This object is
+ * supposed to be a singleton
+ * 
+ * Returns: an instance of a #ModestConf
+ **/
+ModestConf*     modest_tny_platform_factory_get_modest_conf_instance (TnyPlatformFactory *fact);
+
+/**
+ * modest_tny_platform_factory_get_modest_mail_operation_queue_instance:
+ * @fact: the #TnyPlatformFactory that holds the #ModestMailOperationQueue instance
+ * 
+ * Gets a new instance of a #ModestMailOperationQueue if it is the
+ * first call to the function, or the current instantiated one
+ * otherwise. This object is supposed to be a singleton
+ * 
+ * Returns: an instance of a #ModestMailOperationQueue
+ **/
+ModestMailOperationQueue*   modest_tny_platform_factory_get_modest_mail_operation_queue_instance (TnyPlatformFactory *fact);
 
 G_END_DECLS