updated Doxyfile
[strongswan.git] / src / charon / plugins / unit_tester / unit_tester.h
1 /*
2 * Copyright (C) 2007 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * $Id$
16 */
17
18 /**
19 * @defgroup unit_tester unit_tester
20 * @{ @ingroup cplugins
21 */
22
23 #ifndef UNIT_TESTER_H_
24 #define UNIT_TESTER_H_
25
26 #include <plugins/plugin.h>
27
28 typedef struct unit_tester_t unit_tester_t;
29
30 /**
31 * Unit testing plugin.
32 *
33 * The unit testing plugin runs tests on plugin initialization. Tests are
34 * defined in tests.h using the DEFINE_TEST macro. Implementation of the
35 * tests is done in the tests folder. Each test has uses a function which
36 * returns TRUE for success or FALSE for failure.
37 */
38 struct unit_tester_t {
39
40 /**
41 * Implements the plugin interface.
42 */
43 plugin_t plugin;
44 };
45
46 /**
47 * Create a unit_tester plugin.
48 */
49 plugin_t *plugin_create();
50
51 #endif /** UNIT_TESTER_H_ @}*/