[evolution-data-server/documentation-effort: 17/18] ETestServerFixture: Adding main gtk-doc description



commit 8b1e25c65d53db3f04f5c4f698a3d40466b61115
Author: Tristan Van Berkom <tristan upstairslabs com>
Date:   Thu Dec 5 20:30:49 2013 +0900

    ETestServerFixture: Adding main gtk-doc description

 tests/test-server-utils/e-test-server-utils.c |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
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>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]