aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_program_lib.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-08-21 15:16:58 +0000
committerChristian Grothoff <christian@grothoff.org>2013-08-21 15:16:58 +0000
commit5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b (patch)
tree7ba261fc1882bcfa6dc0da916272a0ed0d17468e /src/include/gnunet_program_lib.h
parent1fca0c918c8468ba16666e8a1c41526cacdc6df2 (diff)
downloadgnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.tar.gz
gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.zip
-misc doxygen fixes
Diffstat (limited to 'src/include/gnunet_program_lib.h')
-rw-r--r--src/include/gnunet_program_lib.h22
1 files changed, 13 insertions, 9 deletions
diff --git a/src/include/gnunet_program_lib.h b/src/include/gnunet_program_lib.h
index fa96ecf3c..cae1913a0 100644
--- a/src/include/gnunet_program_lib.h
+++ b/src/include/gnunet_program_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, 2007, 2009 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
@@ -22,6 +22,8 @@
22 * @file include/gnunet_program_lib.h 22 * @file include/gnunet_program_lib.h
23 * @brief functions related to starting programs 23 * @brief functions related to starting programs
24 * @author Christian Grothoff 24 * @author Christian Grothoff
25 * @defgroup program functions for writing command-line programs
26 * @{
25 */ 27 */
26 28
27#ifndef GNUNET_PROGRAM_LIB_H 29#ifndef GNUNET_PROGRAM_LIB_H
@@ -57,16 +59,16 @@ typedef void (*GNUNET_PROGRAM_Main) (void *cls, char *const *args,
57 * Run a standard GNUnet command startup sequence (initialize loggers 59 * Run a standard GNUnet command startup sequence (initialize loggers
58 * and configuration, parse options). 60 * and configuration, parse options).
59 * 61 *
60 * @param argc number of command line arguments 62 * @param argc number of command line arguments in @a argv
61 * @param argv command line arguments 63 * @param argv command line arguments
62 * @param binaryName our expected name 64 * @param binaryName our expected name
63 * @param binaryHelp help text for the program 65 * @param binaryHelp help text for the program
64 * @param options command line options 66 * @param options command line options
65 * @param task main function to run 67 * @param task main function to run
66 * @param task_cls closure for task 68 * @param task_cls closure for @a task
67 * @param run_without_scheduler GNUNET_NO start the scheduler, GNUNET_YES do not 69 * @param run_without_scheduler #GNUNET_NO start the scheduler,
68 * start the scheduler just run the main task 70 * #GNUNET_YES do not start the scheduler just run the main task
69 * @return GNUNET_SYSERR on error, GNUNET_OK on success 71 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
70 */ 72 */
71int 73int
72GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName, 74GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
@@ -85,8 +87,8 @@ GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
85 * @param binaryHelp helptext for "-h" option (about the app) 87 * @param binaryHelp helptext for "-h" option (about the app)
86 * @param options command line options 88 * @param options command line options
87 * @param task main function to run 89 * @param task main function to run
88 * @param task_cls closure for task 90 * @param task_cls closure for @a task
89 * @return GNUNET_SYSERR on error, GNUNET_OK on success 91 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
90 */ 92 */
91int 93int
92GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName, 94GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
@@ -103,6 +105,8 @@ GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
103} 105}
104#endif 106#endif
105 107
108/** @} */ /* end of group program */
109
106/* ifndef GNUNET_PROGRAM_LIB_H */ 110/* ifndef GNUNET_PROGRAM_LIB_H */
107#endif 111#endif
108/* end of gnunet_program_lib.h */ 112/* end of gnunet_program_lib.h */