Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/bin
Modified Files:
Ewl_Test.h
Log Message:
- some doxy work
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/bin/Ewl_Test.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- Ewl_Test.h 10 Mar 2006 18:36:44 -0000 1.2
+++ Ewl_Test.h 10 Mar 2006 20:52:03 -0000 1.3
@@ -10,6 +10,10 @@
#define __UNUSED__
#endif
+/**
+ * @enum Ewl_Test_Type
+ * The different types of tests available
+ */
enum Ewl_Test_Type
{
EWL_TEST_TYPE_SIMPLE,
@@ -20,24 +24,38 @@
};
typedef enum Ewl_Test_Type Ewl_Test_Type;
+/**
+ * Provides information on a unit test
+ */
typedef struct Ewl_Unit_Test Ewl_Unit_Test;
+
+/**
+ * Contains the information needed to run a unit test
+ */
struct Ewl_Unit_Test
{
- const char *name;
- int (*func)(char *buf, int len);
+ const char *name; /**< The test name */
+ int (*func)(char *buf, int len); /**< The test function */
};
+/**
+ * Provides information on an Ewl Test set
+ */
typedef struct Ewl_Test Ewl_Test;
+
+/**
+ * Holds information on an Ewl Test set
+ */
struct Ewl_Test
{
- const char *name;
- const char *filename;
- const char *tip;
-
- void *handle;
- Ewl_Test_Type type;
- int (*func)(Ewl_Container *con);
- Ewl_Unit_Test *unit_tests;
+ const char *name; /**< The test name */
+ const char *filename; /**< Filename of the test */
+ const char *tip; /**< Tooltip for the test */
+
+ void *handle; /**< Dynamic file handle for test */
+ Ewl_Test_Type type; /**< The type of test */
+ int (*func)(Ewl_Container *con); /**< The test function */
+ Ewl_Unit_Test *unit_tests; /**< The test unit tests */
};
#endif
-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
