diff options
author | Pierre Le Magourou <pierre.lemagourou@openwide.fr> | 2014-10-15 17:59:55 +0200 |
---|---|---|
committer | Cedric BAIL <cedric@osg.samsung.com> | 2014-10-20 18:17:26 +0200 |
commit | 6a9cfbcfef8a1b947de3266931cdec6bfae38cbc (patch) | |
tree | 61078baa6ea9a5337ff53ee0a43d6727f9259f34 /src | |
parent | 42a7d9b71c05153c90c4224996bdabcd1d9defab (diff) |
ecore: update the doxygen groups to compile forgotten parts of the API.
Some parts of the API documentation where not compiled at all by doxygen
because of missing '@{' and '@}' tags. This commit adds the missing tags
in Ecore_Getopt.h, Ecore_Con_Eet.h, and Ecore_IMF.h headers.
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/ecore/Ecore_Getopt.h | 13 | ||||
-rw-r--r-- | src/lib/ecore_con/Ecore_Con_Eet.h | 10 | ||||
-rw-r--r-- | src/lib/ecore_imf/Ecore_IMF.h | 2 |
3 files changed, 21 insertions, 4 deletions
diff --git a/src/lib/ecore/Ecore_Getopt.h b/src/lib/ecore/Ecore_Getopt.h index 439e021782..a20cc98e02 100644 --- a/src/lib/ecore/Ecore_Getopt.h +++ b/src/lib/ecore/Ecore_Getopt.h | |||
@@ -31,8 +31,10 @@ | |||
31 | #endif /* ! _WIN32 */ | 31 | #endif /* ! _WIN32 */ |
32 | 32 | ||
33 | /** | 33 | /** |
34 | * @file Ecore_Getopt.h | 34 | * @defgroup Ecore_Getopt_Group Ecore Getopt |
35 | * @brief Contains powerful getopt replacement. | 35 | * @ingroup Ecore |
36 | * | ||
37 | * This group contains powerful getopt replacement. | ||
36 | * | 38 | * |
37 | * This replacement handles both short (-X) or long options (--ABC) | 39 | * This replacement handles both short (-X) or long options (--ABC) |
38 | * options, with various actions supported, like storing one value and | 40 | * options, with various actions supported, like storing one value and |
@@ -46,6 +48,8 @@ | |||
46 | * Values will be stored elsewhere indicated by an array of pointers | 48 | * Values will be stored elsewhere indicated by an array of pointers |
47 | * to values, it is given in separate to parser description so you can | 49 | * to values, it is given in separate to parser description so you can |
48 | * use multiple values with the same parser. | 50 | * use multiple values with the same parser. |
51 | * | ||
52 | * @{ | ||
49 | */ | 53 | */ |
50 | 54 | ||
51 | #ifdef __cplusplus | 55 | #ifdef __cplusplus |
@@ -1206,4 +1210,9 @@ EAPI Eina_Bool ecore_getopt_callback_size_parse(const Ecore_Getopt *parser, con | |||
1206 | #ifdef __cplusplus | 1210 | #ifdef __cplusplus |
1207 | } | 1211 | } |
1208 | #endif | 1212 | #endif |
1213 | |||
1214 | /** | ||
1215 | * @} | ||
1216 | */ | ||
1217 | |||
1209 | #endif /* _ECORE_GETOPT_H */ | 1218 | #endif /* _ECORE_GETOPT_H */ |
diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h index 95373c46b8..a6c52bd328 100644 --- a/src/lib/ecore_con/Ecore_Con_Eet.h +++ b/src/lib/ecore_con/Ecore_Con_Eet.h | |||
@@ -32,13 +32,15 @@ | |||
32 | #endif | 32 | #endif |
33 | 33 | ||
34 | /** | 34 | /** |
35 | * @defgroup Ecore_Con_Eet_Group Ecore_Con_Eet - Eet connection functions | 35 | * @defgroup Ecore_Con_Eet_Group Eet connection functions |
36 | * @ingroup Ecore | 36 | * @ingroup Ecore_Con_Group |
37 | * | 37 | * |
38 | * The Ecore Connection Eet library ( @c Ecore_Con_Eet) adds @c Eet data | 38 | * The Ecore Connection Eet library ( @c Ecore_Con_Eet) adds @c Eet data |
39 | * serialization features to Ecore Connection objects. Its main aim is to | 39 | * serialization features to Ecore Connection objects. Its main aim is to |
40 | * provide a way to send @c Eet data streams to another program through sockets | 40 | * provide a way to send @c Eet data streams to another program through sockets |
41 | * using @c Ecore_Con objects. | 41 | * using @c Ecore_Con objects. |
42 | * | ||
43 | * @{ | ||
42 | */ | 44 | */ |
43 | 45 | ||
44 | typedef struct _Ecore_Con_Eet Ecore_Con_Eet; | 46 | typedef struct _Ecore_Con_Eet Ecore_Con_Eet; |
@@ -275,4 +277,8 @@ EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, | |||
275 | */ | 277 | */ |
276 | EAPI void ecore_con_eet_raw_send(Ecore_Con_Reply *reply, const char *protocol_name, const char *section, void *value, unsigned int length); | 278 | EAPI void ecore_con_eet_raw_send(Ecore_Con_Reply *reply, const char *protocol_name, const char *section, void *value, unsigned int length); |
277 | 279 | ||
280 | /** | ||
281 | * @} | ||
282 | */ | ||
283 | |||
278 | #endif | 284 | #endif |
diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h index 374c0904a1..5618f3130d 100644 --- a/src/lib/ecore_imf/Ecore_IMF.h +++ b/src/lib/ecore_imf/Ecore_IMF.h | |||
@@ -1805,6 +1805,7 @@ EAPI Eina_Bool ecore_imf_context_input_panel_show_on_demand_ | |||
1805 | /** | 1805 | /** |
1806 | * @brief Sets the bidirectionality at the current cursor position. | 1806 | * @brief Sets the bidirectionality at the current cursor position. |
1807 | * | 1807 | * |
1808 | * @ingroup Ecore_IMF_Context_Group | ||
1808 | * @since 1.12.0 | 1809 | * @since 1.12.0 |
1809 | * | 1810 | * |
1810 | * @param[in] ctx An #Ecore_IMF_Context | 1811 | * @param[in] ctx An #Ecore_IMF_Context |
@@ -1815,6 +1816,7 @@ EAPI void ecore_imf_context_bidi_direction_set(Ecore_IM | |||
1815 | /** | 1816 | /** |
1816 | * @brief Gets the bidirectionality at the current cursor position. | 1817 | * @brief Gets the bidirectionality at the current cursor position. |
1817 | * | 1818 | * |
1819 | * @ingroup Ecore_IMF_Context_Group | ||
1818 | * @since 1.12.0 | 1820 | * @since 1.12.0 |
1819 | * | 1821 | * |
1820 | * @param[in] ctx An #Ecore_IMF_Context | 1822 | * @param[in] ctx An #Ecore_IMF_Context |