diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-08-21 15:16:58 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-08-21 15:16:58 +0000 |
commit | 5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b (patch) | |
tree | 7ba261fc1882bcfa6dc0da916272a0ed0d17468e /src/include/gnunet_getopt_lib.h | |
parent | 1fca0c918c8468ba16666e8a1c41526cacdc6df2 (diff) | |
download | gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.tar.gz gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.zip |
-misc doxygen fixes
Diffstat (limited to 'src/include/gnunet_getopt_lib.h')
-rw-r--r-- | src/include/gnunet_getopt_lib.h | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h index ce54674d8..a6650fe03 100644 --- a/src/include/gnunet_getopt_lib.h +++ b/src/include/gnunet_getopt_lib.h | |||
@@ -1,10 +1,10 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of GNUnet. | 2 | This file is part of GNUnet. |
3 | (C) 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2011 Christian Grothoff (and other contributing authors) | 3 | (C) 2001-2013 Christian Grothoff (and other contributing authors) |
4 | 4 | ||
5 | GNUnet is free software; you can redistribute it and/or modify | 5 | GNUnet is free software; you can redistribute it and/or modify |
6 | it under the terms of the GNU General Public License as published | 6 | it under the terms of the GNU General Public License as published |
7 | by the Free Software Foundation; either version 2, or (at your | 7 | by the Free Software Foundation; either version 3, or (at your |
8 | option) any later version. | 8 | option) any later version. |
9 | 9 | ||
10 | GNUnet is distributed in the hope that it will be useful, but | 10 | GNUnet is distributed in the hope that it will be useful, but |
@@ -21,8 +21,9 @@ | |||
21 | /** | 21 | /** |
22 | * @file include/gnunet_getopt_lib.h | 22 | * @file include/gnunet_getopt_lib.h |
23 | * @brief command line parsing and --help formatting | 23 | * @brief command line parsing and --help formatting |
24 | * | ||
25 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
25 | * @defgroup getopt command-line parsing | ||
26 | * @{ | ||
26 | */ | 27 | */ |
27 | 28 | ||
28 | #ifndef GNUNET_GETOPT_LIB_H | 29 | #ifndef GNUNET_GETOPT_LIB_H |
@@ -83,7 +84,7 @@ struct GNUNET_GETOPT_CommandLineProcessorContext | |||
83 | * @param scls specific closure (for this processor) | 84 | * @param scls specific closure (for this processor) |
84 | * @param option long name of the option (i.e. "config" for --config) | 85 | * @param option long name of the option (i.e. "config" for --config) |
85 | * @param value argument, NULL if none was given | 86 | * @param value argument, NULL if none was given |
86 | * @return GNUNET_OK to continue processing other options, GNUNET_SYSERR to abort | 87 | * @return #GNUNET_OK to continue processing other options, #GNUNET_SYSERR to abort |
87 | */ | 88 | */ |
88 | typedef int (*GNUNET_GETOPT_CommandLineOptionProcessor) (struct | 89 | typedef int (*GNUNET_GETOPT_CommandLineOptionProcessor) (struct |
89 | GNUNET_GETOPT_CommandLineProcessorContext | 90 | GNUNET_GETOPT_CommandLineProcessorContext |
@@ -202,10 +203,10 @@ struct GNUNET_GETOPT_CommandLineOption | |||
202 | * | 203 | * |
203 | * @param binaryOptions Name of application with option summary | 204 | * @param binaryOptions Name of application with option summary |
204 | * @param allOptions defined options and handlers | 205 | * @param allOptions defined options and handlers |
205 | * @param argc number of arguments | 206 | * @param argc number of arguments in @a argv |
206 | * @param argv actual arguments | 207 | * @param argv actual arguments |
207 | * @return index into argv with first non-option | 208 | * @return index into argv with first non-option |
208 | * argument, or GNUNET_SYSERR on error | 209 | * argument, or #GNUNET_SYSERR on error |
209 | */ | 210 | */ |
210 | int | 211 | int |
211 | GNUNET_GETOPT_run (const char *binaryOptions, | 212 | GNUNET_GETOPT_run (const char *binaryOptions, |
@@ -224,7 +225,7 @@ GNUNET_GETOPT_run (const char *binaryOptions, | |||
224 | * @param scls additional closure (will point to the 'unsigned long long') | 225 | * @param scls additional closure (will point to the 'unsigned long long') |
225 | * @param option name of the option | 226 | * @param option name of the option |
226 | * @param value actual value of the option as a string. | 227 | * @param value actual value of the option as a string. |
227 | * @return GNUNET_OK if parsing the value worked | 228 | * @return #GNUNET_OK if parsing the value worked |
228 | */ | 229 | */ |
229 | int | 230 | int |
230 | GNUNET_GETOPT_set_ulong (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | 231 | GNUNET_GETOPT_set_ulong (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, |
@@ -242,7 +243,7 @@ GNUNET_GETOPT_set_ulong (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | |||
242 | * @param scls additional closure (will point to the 'struct GNUNET_TIME_Relative') | 243 | * @param scls additional closure (will point to the 'struct GNUNET_TIME_Relative') |
243 | * @param option name of the option | 244 | * @param option name of the option |
244 | * @param value actual value of the option as a string. | 245 | * @param value actual value of the option as a string. |
245 | * @return GNUNET_OK if parsing the value worked | 246 | * @return #GNUNET_OK if parsing the value worked |
246 | */ | 247 | */ |
247 | int | 248 | int |
248 | GNUNET_GETOPT_set_relative_time (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | 249 | GNUNET_GETOPT_set_relative_time (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, |
@@ -260,7 +261,7 @@ GNUNET_GETOPT_set_relative_time (struct GNUNET_GETOPT_CommandLineProcessorContex | |||
260 | * @param scls additional closure (will point to the 'unsigned int') | 261 | * @param scls additional closure (will point to the 'unsigned int') |
261 | * @param option name of the option | 262 | * @param option name of the option |
262 | * @param value actual value of the option as a string. | 263 | * @param value actual value of the option as a string. |
263 | * @return GNUNET_OK if parsing the value worked | 264 | * @return #GNUNET_OK if parsing the value worked |
264 | */ | 265 | */ |
265 | int | 266 | int |
266 | GNUNET_GETOPT_set_uint (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | 267 | GNUNET_GETOPT_set_uint (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, |
@@ -279,7 +280,7 @@ GNUNET_GETOPT_set_uint (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | |||
279 | * @param scls additional closure (will point to the 'int') | 280 | * @param scls additional closure (will point to the 'int') |
280 | * @param option name of the option | 281 | * @param option name of the option |
281 | * @param value not used (NULL) | 282 | * @param value not used (NULL) |
282 | * @return GNUNET_OK | 283 | * @return #GNUNET_OK (always) |
283 | */ | 284 | */ |
284 | int | 285 | int |
285 | GNUNET_GETOPT_set_one (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | 286 | GNUNET_GETOPT_set_one (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, |
@@ -298,7 +299,7 @@ GNUNET_GETOPT_set_one (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | |||
298 | * which will be allocated) | 299 | * which will be allocated) |
299 | * @param option name of the option | 300 | * @param option name of the option |
300 | * @param value actual value of the option (a string) | 301 | * @param value actual value of the option (a string) |
301 | * @return GNUNET_OK | 302 | * @return #GNUNET_OK (always) |
302 | */ | 303 | */ |
303 | int | 304 | int |
304 | GNUNET_GETOPT_set_string (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | 305 | GNUNET_GETOPT_set_string (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, |
@@ -317,7 +318,7 @@ GNUNET_GETOPT_set_string (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | |||
317 | * which will be allocated) | 318 | * which will be allocated) |
318 | * @param option name of the option | 319 | * @param option name of the option |
319 | * @param value actual value of the option (a string) | 320 | * @param value actual value of the option (a string) |
320 | * @return GNUNET_OK | 321 | * @return #GNUNET_OK (always) |
321 | */ | 322 | */ |
322 | int | 323 | int |
323 | GNUNET_GETOPT_set_filename (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, | 324 | GNUNET_GETOPT_set_filename (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, |
@@ -335,7 +336,7 @@ GNUNET_GETOPT_set_filename (struct GNUNET_GETOPT_CommandLineProcessorContext *ct | |||
335 | * @param scls additional closure (will point to the 'int') | 336 | * @param scls additional closure (will point to the 'int') |
336 | * @param option name of the option | 337 | * @param option name of the option |
337 | * @param value not used (NULL) | 338 | * @param value not used (NULL) |
338 | * @return GNUNET_OK | 339 | * @return #GNUNET_OK (always) |
339 | */ | 340 | */ |
340 | int | 341 | int |
341 | GNUNET_GETOPT_increment_value (struct GNUNET_GETOPT_CommandLineProcessorContext | 342 | GNUNET_GETOPT_increment_value (struct GNUNET_GETOPT_CommandLineProcessorContext |
@@ -352,7 +353,7 @@ GNUNET_GETOPT_increment_value (struct GNUNET_GETOPT_CommandLineProcessorContext | |||
352 | * @param scls additional closure (points to about text) | 353 | * @param scls additional closure (points to about text) |
353 | * @param option name of the option | 354 | * @param option name of the option |
354 | * @param value not used (NULL) | 355 | * @param value not used (NULL) |
355 | * @return GNUNET_NO (do not continue, not an error) | 356 | * @return #GNUNET_NO (do not continue, not an error) |
356 | */ | 357 | */ |
357 | int | 358 | int |
358 | GNUNET_GETOPT_format_help_ (struct GNUNET_GETOPT_CommandLineProcessorContext | 359 | GNUNET_GETOPT_format_help_ (struct GNUNET_GETOPT_CommandLineProcessorContext |
@@ -366,7 +367,7 @@ GNUNET_GETOPT_format_help_ (struct GNUNET_GETOPT_CommandLineProcessorContext | |||
366 | * @param scls additional closure (points to version string) | 367 | * @param scls additional closure (points to version string) |
367 | * @param option name of the option | 368 | * @param option name of the option |
368 | * @param value not used (NULL) | 369 | * @param value not used (NULL) |
369 | * @return GNUNET_NO (do not continue, not an error) | 370 | * @return #GNUNET_NO (do not continue, not an error) |
370 | */ | 371 | */ |
371 | int | 372 | int |
372 | GNUNET_GETOPT_print_version_ (struct GNUNET_GETOPT_CommandLineProcessorContext | 373 | GNUNET_GETOPT_print_version_ (struct GNUNET_GETOPT_CommandLineProcessorContext |
@@ -380,6 +381,7 @@ GNUNET_GETOPT_print_version_ (struct GNUNET_GETOPT_CommandLineProcessorContext | |||
380 | } | 381 | } |
381 | #endif | 382 | #endif |
382 | 383 | ||
384 | /** @} */ /* end of group getopt */ | ||
383 | 385 | ||
384 | /* ifndef GNUNET_GETOPT_LIB_H */ | 386 | /* ifndef GNUNET_GETOPT_LIB_H */ |
385 | #endif | 387 | #endif |