From: Tristan Van Berkom <tristan@upstairslabs.com>
Date: Fri, 6 Dec 2013 06:07:44 +0000 (+0900)
Subject: ETestServerFixture: Fixing gtk-doc comments.
X-Git-Tag: submit/tizen/20140917.130222~216
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=86974d145cf519733aeecc13fe05c60376b44e14;p=platform%2Fupstream%2Fevolution-data-server.git

ETestServerFixture: Fixing gtk-doc comments.
---

diff --git a/tests/test-server-utils/e-test-server-utils.c b/tests/test-server-utils/e-test-server-utils.c
index 4564521..7ef27b6 100644
--- a/tests/test-server-utils/e-test-server-utils.c
+++ b/tests/test-server-utils/e-test-server-utils.c
@@ -20,6 +20,21 @@
  * Authors: Tristan Van Berkom <tristanvb@openismus.com>
  */
 
+/**
+ * SECTION: e-test-server-utils
+ * @short_description: A utility for unit testing EDS
+ *
+ * This test fixture provides an encapsulated testing environment for test
+ * cases to test #EBookClient and #ECalClient.
+ *
+ * The #ETestServerFixture should be used as a fixture and must be coupled
+ * with the #ETestServerClosure to configure how the test fixture will operate.
+ *
+ * Both the #ETestServerFixture and #ETestServerClosure can be extended with
+ * more complex test fixtures, which must remember to call e_test_server_utils_setup()
+ * and e_test_server_utils_teardown() in thier fixture's setup and teardown routines.
+ **/
+
 #include "e-test-server-utils.h"
 
 #include <sys/wait.h>
diff --git a/tests/test-server-utils/e-test-server-utils.h b/tests/test-server-utils/e-test-server-utils.h
index 734a005..6220770 100644
--- a/tests/test-server-utils/e-test-server-utils.h
+++ b/tests/test-server-utils/e-test-server-utils.h
@@ -77,10 +77,14 @@ typedef enum {
 
 /**
  * ETestServerClosure:
- * @flags:                The #ETestServiceFlags to use for this test
  * @customize:            An #ETestSourceCustomizeFunc to use to parameterize the scratch #ESource, or %NULL
  * @calendar_source_type: An #ECalClientSourceType or #ECalSourceType; for %E_TEST_SERVER_CALENDAR
  *                        and %E_TEST_SERVER_DEPRECATED_CALENDAR tests
+ * @keep_work_directory:  If specified, the work directory will not be deleted between tests
+ * @destroy_closure_func: A function to destroy an allocated #ETestServerClosure, this it
+ *                        typically used by sub-fixtures which embed this structure in their closures.
+ * @use_async_connect:    Specifies whether a synchronous or asyncrhonous API should be used to
+ *                        create the #EClient you plan to test.
  *
  * This structure provides the parameters for the #ETestServerFixture tests,
  * it can be included as the first member of a derived structure
@@ -97,6 +101,7 @@ struct _ETestServerClosure {
 
 /**
  * ETestService:
+ * @generic: A generic pointer for the test service.
  * @book_client: An #EBookClient, created for %E_TEST_SERVER_ADDRESS_BOOK tests
  * @calendar_client: An #ECalClient, created for %E_TEST_SERVER_CALENDAR tests
  * @book: An #EBook, created for %E_TEST_SERVER_DEPRECATED_ADDRESS_BOOK tests
@@ -119,8 +124,8 @@ typedef union {
  * @dbus: The D-Bus test scaffold
  * @registry: An #ESourceRegistry
  * @service: The #ETestService
- * @source_name: A private detail, the ESource name used for this test case
- * @timeout_source_id: A private detail, tracks the idle source which times out if the registry cannot create an ESource.
+ * @source_name: This can be given an allocated string before calling e_test_server_utils_setup() and will be the #ESource UID
+ * for the test addressbook or calendar, leaving this %NULL will result in a suitable unique id being generated for the test. 
  *
  * A fixture for running tests on the Evolution Data Server
  * components in an encapsulated D-Bus environment.
@@ -131,6 +136,8 @@ struct _ETestServerFixture {
 	ESourceRegistry *registry;
 	ETestService     service;
 	gchar           *source_name;
+
+	/*< private >*/
 	guint            timeout_source_id;
 	GWeakRef         registry_ref;
 	GWeakRef         client_ref;