convert fs publish to MQ

[oweals/gnunet.git] / src / include / gnunet_getopt_lib.h

diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h
index a6650fe033ce3e415c59bd13e7b0ee4b13555ee4..b04020a7057fde8e5dba8ca6dc3d108def2ffc10 100644 (file)
--- a/src/include/gnunet_getopt_lib.h
+++ b/src/include/gnunet_getopt_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001-2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001-2013 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,15 +14,18 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
- * @file include/gnunet_getopt_lib.h
- * @brief command line parsing and --help formatting
  * @author Christian Grothoff
- * @defgroup getopt command-line parsing
+ *
+ * @file
+ * Command line parsing and --help formatting
+ *
+ * @defgroup getopt  Getopt library
+ * Command line parsing and --help formatting
  * @{
  */
 
@@ -77,6 +80,7 @@ struct GNUNET_GETOPT_CommandLineProcessorContext
 
 };
 
+
 /**
  * @brief Process a command line option
  *
@@ -86,11 +90,12 @@ struct GNUNET_GETOPT_CommandLineProcessorContext
  * @param value argument, NULL if none was given
  * @return #GNUNET_OK to continue processing other options, #GNUNET_SYSERR to abort
  */
-typedef int (*GNUNET_GETOPT_CommandLineOptionProcessor) (struct
-                                                         GNUNET_GETOPT_CommandLineProcessorContext
-                                                         * ctx, void *scls,
-                                                         const char *option,
-                                                         const char *value);
+typedef int
+(*GNUNET_GETOPT_CommandLineOptionProcessor) (struct
+                                             GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+                                             void *scls,
+                                             const char *option,
+                                             const char *value);
 
 /**
  * @brief Definition of a command line option.
@@ -99,7 +104,7 @@ struct GNUNET_GETOPT_CommandLineOption
 {
 
   /**
-   * Short name of the option (use '\\0' for none).
+   * Short name of the option.
    */
   const char shortName;
 
@@ -119,7 +124,8 @@ struct GNUNET_GETOPT_CommandLineOption
   const char *description;
 
   /**
-   * Is an argument required?  0: GNUNET_NO (includes optional), 1: GNUNET_YES.
+   * Is an argument required?  #GNUNET_NO (includes optional) or
+   * #GNUNET_YES (required)
    */
   int require_argument;
 
@@ -217,9 +223,9 @@ GNUNET_GETOPT_run (const char *binaryOptions,
 /**
  * Set an option of type 'unsigned long long' from the command line.
  * A pointer to this function should be passed as part of the
- * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * `struct GNUNET_GETOPT_CommandLineOption` array to initialize options
  * of this type.  It should be followed by a pointer to a value of
- * type 'unsigned long long'.
+ * type `unsigned long long`.
  *
  * @param ctx command line processing context
  * @param scls additional closure (will point to the 'unsigned long long')
@@ -235,9 +241,9 @@ GNUNET_GETOPT_set_ulong (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
 /**
  * Set an option of type 'struct GNUNET_TIME_Relative' from the command line.
  * A pointer to this function should be passed as part of the
- * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * `struct GNUNET_GETOPT_CommandLineOption` array to initialize options
  * of this type.  It should be followed by a pointer to a value of
- * type 'struct GNUNET_TIME_Relative'.
+ * type `struct GNUNET_TIME_Relative`.
  *
  * @param ctx command line processing context
  * @param scls additional closure (will point to the 'struct GNUNET_TIME_Relative')
@@ -253,9 +259,9 @@ GNUNET_GETOPT_set_relative_time (struct GNUNET_GETOPT_CommandLineProcessorContex
 /**
  * Set an option of type 'unsigned int' from the command line.
  * A pointer to this function should be passed as part of the
- * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * `struct GNUNET_GETOPT_CommandLineOption` array to initialize options
  * of this type.  It should be followed by a pointer to a value of
- * type 'unsigned int'.
+ * type `unsigned int`.
  *
  * @param ctx command line processing context
  * @param scls additional closure (will point to the 'unsigned int')
@@ -272,12 +278,12 @@ GNUNET_GETOPT_set_uint (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
  * Set an option of type 'int' from the command line to 1 if the
  * given option is present.
  * A pointer to this function should be passed as part of the
- * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * `struct GNUNET_GETOPT_CommandLineOption` array to initialize options
  * of this type.  It should be followed by a pointer to a value of
- * type 'int'.
+ * type `int`.
  *
  * @param ctx command line processing context
- * @param scls additional closure (will point to the 'int')
+ * @param scls additional closure (will point to the `int`)
  * @param option name of the option
  * @param value not used (NULL)
  * @return #GNUNET_OK (always)
@@ -290,12 +296,12 @@ GNUNET_GETOPT_set_one (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
 /**
  * Set an option of type 'char *' from the command line.
  * A pointer to this function should be passed as part of the
- * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * `struct GNUNET_GETOPT_CommandLineOption` array to initialize options
  * of this type.  It should be followed by a pointer to a value of
- * type 'char *', which will be allocated with the requested string.
+ * type `char *`, which will be allocated with the requested string.
  *
  * @param ctx command line processing context
- * @param scls additional closure (will point to the 'char *',
+ * @param scls additional closure (will point to the `char *`,
  *             which will be allocated)
  * @param option name of the option
  * @param value actual value of the option (a string)
@@ -381,8 +387,9 @@ GNUNET_GETOPT_print_version_ (struct GNUNET_GETOPT_CommandLineProcessorContext
 }
 #endif
 
-/** @} */ /* end of group getopt */
-
 /* ifndef GNUNET_GETOPT_LIB_H */
 #endif
+
+/** @} */ /* end of group getopt */
+
 /* end of gnunet_getopt_lib.h */