diff options
author | Gabor X Toth <*@tg-x.net> | 2016-01-11 21:23:17 +0000 |
---|---|---|
committer | Gabor X Toth <*@tg-x.net> | 2016-01-11 21:23:17 +0000 |
commit | b23f7bcde58fdada9170f16af39ab1e84f4c3a68 (patch) | |
tree | 7b41d9839d854eef7ebd6b93fa161c55221a6577 /src/include/gnunet_ats_plugin.h | |
parent | 1e53d26243bc986844a7b5b53bedeefb61dd7960 (diff) | |
download | gnunet-b23f7bcde58fdada9170f16af39ab1e84f4c3a68.tar.gz gnunet-b23f7bcde58fdada9170f16af39ab1e84f4c3a68.zip |
doxygen: group/module definitions (part 1)
Diffstat (limited to 'src/include/gnunet_ats_plugin.h')
-rw-r--r-- | src/include/gnunet_ats_plugin.h | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/src/include/gnunet_ats_plugin.h b/src/include/gnunet_ats_plugin.h index 71572d64e..19003aa02 100644 --- a/src/include/gnunet_ats_plugin.h +++ b/src/include/gnunet_ats_plugin.h | |||
@@ -19,14 +19,20 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_ats_plugin.h | ||
23 | * @brief API for the ATS solvers. This header | ||
24 | * specifies the struct that is given to the plugin's entry | ||
25 | * method and the other struct that must be returned. | ||
26 | * Note that the destructors of ATS plugins will | ||
27 | * be given the value returned by the constructor | ||
28 | * and is expected to return a NULL pointer. | ||
29 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API for the ATS solvers. | ||
26 | * | ||
27 | * @defgroup ats-plugin ATS service plugin API | ||
28 | * Plugin API for the ATS service. | ||
29 | * | ||
30 | * Specifies the struct that is given to the plugin's entry method and the other | ||
31 | * struct that must be returned. Note that the destructors of ATS plugins will | ||
32 | * be given the value returned by the constructor and is expected to return a | ||
33 | * NULL pointer. | ||
34 | * | ||
35 | * @{ | ||
30 | */ | 36 | */ |
31 | #ifndef PLUGIN_ATS_H | 37 | #ifndef PLUGIN_ATS_H |
32 | #define PLUGIN_ATS_H | 38 | #define PLUGIN_ATS_H |
@@ -472,4 +478,6 @@ struct GNUNET_ATS_PluginEnvironment | |||
472 | unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; | 478 | unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; |
473 | }; | 479 | }; |
474 | 480 | ||
481 | /** @} */ /* end of group */ | ||
482 | |||
475 | #endif | 483 | #endif |