diff options
author | Christian Grothoff <christian@grothoff.org> | 2021-01-07 10:26:54 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2021-01-07 10:26:54 +0100 |
commit | 5b10ad755f132e849ee35516fefe27df64eb188d (patch) | |
tree | 4400517ca25353057c320b992827553b16a45200 /src/include/gnunet_program_lib.h | |
parent | 90499cabec25be14fb96bb3d62b791c5bf3470c2 (diff) | |
download | gnunet-5b10ad755f132e849ee35516fefe27df64eb188d.tar.gz gnunet-5b10ad755f132e849ee35516fefe27df64eb188d.zip |
properly document return value of GNUNET_PROGRAM_run
Diffstat (limited to 'src/include/gnunet_program_lib.h')
-rw-r--r-- | src/include/gnunet_program_lib.h | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/include/gnunet_program_lib.h b/src/include/gnunet_program_lib.h index adb159e55..4167060c0 100644 --- a/src/include/gnunet_program_lib.h +++ b/src/include/gnunet_program_lib.h | |||
@@ -72,9 +72,12 @@ typedef void | |||
72 | * @param task_cls closure for @a task | 72 | * @param task_cls closure for @a task |
73 | * @param run_without_scheduler #GNUNET_NO start the scheduler, | 73 | * @param run_without_scheduler #GNUNET_NO start the scheduler, |
74 | * #GNUNET_YES do not start the scheduler just run the main task | 74 | * #GNUNET_YES do not start the scheduler just run the main task |
75 | * @return #GNUNET_SYSERR on error, #GNUNET_OK on success | 75 | * @return #GNUNET_SYSERR on error, |
76 | * #GNUNET_NO if successful option processing called | ||
77 | * for the program to terminate, | ||
78 | * #GNUNET_OK on success (#a task was invoked) | ||
76 | */ | 79 | */ |
77 | int | 80 | enum GNUNET_GenericReturnValue |
78 | GNUNET_PROGRAM_run2 (int argc, | 81 | GNUNET_PROGRAM_run2 (int argc, |
79 | char *const *argv, | 82 | char *const *argv, |
80 | const char *binaryName, | 83 | const char *binaryName, |
@@ -96,9 +99,12 @@ GNUNET_PROGRAM_run2 (int argc, | |||
96 | * @param options command line options | 99 | * @param options command line options |
97 | * @param task main function to run | 100 | * @param task main function to run |
98 | * @param task_cls closure for @a task | 101 | * @param task_cls closure for @a task |
99 | * @return #GNUNET_SYSERR on error, #GNUNET_OK on success | 102 | * @return #GNUNET_SYSERR on error, |
103 | * #GNUNET_NO if successful option processing called | ||
104 | * for the program to terminate, | ||
105 | * #GNUNET_OK on success (#a task was invoked) | ||
100 | */ | 106 | */ |
101 | int | 107 | enum GNUNET_GenericReturnValue |
102 | GNUNET_PROGRAM_run (int argc, | 108 | GNUNET_PROGRAM_run (int argc, |
103 | char *const *argv, | 109 | char *const *argv, |
104 | const char *binaryName, | 110 | const char *binaryName, |