[GNUnet-SVN] r8981 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2009-09-11 05:47:30 -0600 (Fri, 11 Sep 2009)
New Revision: 8981

Modified:
   gnunet/src/include/gnunet_client_lib.h
   gnunet/src/include/gnunet_configuration_lib.h
   gnunet/src/include/gnunet_container_lib.h
   gnunet/src/include/gnunet_strings_lib.h
Log:
docu

Modified: gnunet/src/include/gnunet_client_lib.h
===================================================================
--- gnunet/src/include/gnunet_client_lib.h      2009-09-11 11:36:24 UTC (rev 
8980)
+++ gnunet/src/include/gnunet_client_lib.h      2009-09-11 11:47:30 UTC (rev 
8981)
@@ -85,7 +85,6 @@
 /**
  * Read from the service.
  *
- * @param sched scheduler to use
  * @param sock the service
  * @param handler function to call with the message
  * @param cls closure for handler
@@ -147,7 +146,6 @@
  * Request that the service should shutdown.
  * Afterwards, the connection should be disconnected.
  *
- * @param sched scheduler to use
  * @param sock the socket connected to the service
  */
 void GNUNET_CLIENT_service_shutdown (struct GNUNET_CLIENT_Connection *sock);

Modified: gnunet/src/include/gnunet_configuration_lib.h
===================================================================
--- gnunet/src/include/gnunet_configuration_lib.h       2009-09-11 11:36:24 UTC 
(rev 8980)
+++ gnunet/src/include/gnunet_configuration_lib.h       2009-09-11 11:47:30 UTC 
(rev 8981)
@@ -64,6 +64,8 @@
 
 /**
  * Destroy configuration object.
+ *
+ * @param cfg configuration to destroy
  */
 void GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg);
 
@@ -73,6 +75,7 @@
  * defaults and then parse the specific configuration file
  * to overwrite the defaults.
  *
+ * @param cfg configuration to update
  * @param filename name of the configuration file
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
@@ -83,6 +86,9 @@
 /**
  * Parse a configuration file, add all of the options in the
  * file to the configuration environment.
+ *
+ * @param cfg configuration to update
+ * @param filename name of the configuration file
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -91,6 +97,9 @@
 
 /**
  * Write configuration file.
+ *
+ * @param cfg configuration to write
+ * @param filename where to write the configuration
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -100,6 +109,8 @@
 /**
  * Test if there are configuration options that were
  * changed since the last save.
+ *
+ * @param cfg configuration to inspect
  * @return GNUNET_NO if clean, GNUNET_YES if dirty, GNUNET_SYSERR on error 
(i.e. last save failed)
  */
 int GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle 
*cfg);
@@ -133,6 +144,11 @@
 
 /**
  * Get a configuration value that should be a number.
+ *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
+ * @param number where to store the numeric value of the option
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int GNUNET_CONFIGURATION_get_value_number (const struct 
GNUNET_CONFIGURATION_Handle
@@ -143,6 +159,9 @@
 /**
  * Get a configuration value that should be a relative time.
  *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
  * @param time set to the time value stored in the configuration
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
@@ -153,6 +172,10 @@
 
 /**
  * Test if we have a value for a particular option
+ *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
  * @return GNUNET_YES if so, GNUNET_NO if not.
  */
 int GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle 
*cfg,
@@ -160,6 +183,10 @@
 
 /**
  * Get a configuration value that should be a string.
+ *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
  * @param value will be set to a freshly allocated configuration
  *        value, or NULL if option is not specified
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
@@ -172,6 +199,9 @@
  * Get a configuration value that should be the name of a file
  * or directory.
  *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
  * @param value will be set to a freshly allocated configuration
  *        value, or NULL if option is not specified
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
@@ -185,6 +215,11 @@
 /**
  * Iterate over the set of filenames stored in a configuration value.
  *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
+ * @param cb function to call on each filename
+ * @param cb_cls closure for cb
  * @return number of filenames iterated over, -1 on error
  */
 int GNUNET_CONFIGURATION_iterate_value_filenames (const struct
@@ -193,12 +228,15 @@
                                                   const char *section,
                                                   const char *option,
                                                   GNUNET_FileNameCallback
-                                                  cb, void *cls);
+                                                  cb, void *cb_cls);
 
 /**
  * Get a configuration value that should be in a set of
  * predefined strings
  *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
  * @param choices NULL-terminated list of legal values
  * @param value will be set to an entry in the legal list,
  *        or NULL if option is not specified and no default given
@@ -214,6 +252,9 @@
  * Get a configuration value that should be in a set of
  * "YES" or "NO".
  *
+ * @param cfg configuration to inspect
+ * @param section section of interest
+ * @param option option of interest
  * @return GNUNET_YES, GNUNET_NO or if option has no valid value, GNUNET_SYSERR
  */
 int GNUNET_CONFIGURATION_get_value_yesno (const struct 
GNUNET_CONFIGURATION_Handle
@@ -224,7 +265,8 @@
  * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
  * where either in the "PATHS" section or the environtment
  * "FOO" is set to "DIRECTORY".
-
+ *
+ * @param cfg configuration to use for path expansion
  * @param old string to $-expand (will be freed!)
  * @return $-expanded string
  */
@@ -233,6 +275,11 @@
 
 /**
  * Set a configuration value that should be a number.
+ *
+ * @param cfg configuration to update
+ * @param section section of interest
+ * @param option option of interest
+ * @param number value to set
  */
 void
 GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle
@@ -244,7 +291,11 @@
 
 /**
  * Set a configuration value that should be a string.
- * @param value
+ *
+ * @param cfg configuration to update
+ * @param section section of interest
+ * @param option option of interest
+ * @param value value to set
  */
 void
 GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle
@@ -256,6 +307,9 @@
  * Remove a filename from a configuration value that
  * represents a list of filenames
  *
+ * @param cfg configuration to update
+ * @param section section of interest
+ * @param option option of interest
  * @param value filename to remove
  * @return GNUNET_OK on success,
  *         GNUNET_SYSERR if the filename is not in the list
@@ -271,6 +325,9 @@
  * Append a filename to a configuration value that
  * represents a list of filenames
  *
+ * @param cfg configuration to update
+ * @param section section of interest
+ * @param option option of interest
  * @param value filename to append
  * @return GNUNET_OK on success,
  *         GNUNET_SYSERR if the filename already in the list

Modified: gnunet/src/include/gnunet_container_lib.h
===================================================================
--- gnunet/src/include/gnunet_container_lib.h   2009-09-11 11:36:24 UTC (rev 
8980)
+++ gnunet/src/include/gnunet_container_lib.h   2009-09-11 11:47:30 UTC (rev 
8981)
@@ -62,6 +62,7 @@
 
 /**
  * Load a bloom-filter from a file.
+ *
  * @param filename the name of the file (or the prefix)
  * @param size the size of the bloom-filter (number of
  *        bytes of storage space to use)
@@ -161,7 +162,11 @@
  * data of the given bloom filter.  Assumes that
  * the size of the data array and the current filter
  * match.
+ *
  * @param bf the filter
+ * @param data data to OR-in
+ * @param size size of data
+ * @return GNUNET_OK on success
  */
 int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf,
                                      const char *data, unsigned int size);

Modified: gnunet/src/include/gnunet_strings_lib.h
===================================================================
--- gnunet/src/include/gnunet_strings_lib.h     2009-09-11 11:36:24 UTC (rev 
8980)
+++ gnunet/src/include/gnunet_strings_lib.h     2009-09-11 11:47:30 UTC (rev 
8981)
@@ -116,13 +116,18 @@
 /**
  * "man ctime_r", except for GNUnet time; also, unlike ctime, the
  * return value does not include the newline character.
+ *
+ * @param t the absolute time to convert
+ * @return timestamp in human-readable form
  */
 char *GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t);
 
 
 /**
  * Give relative time in human-readable fancy format.
+ *
  * @param delta time in milli seconds
+ * @return string in human-readable form
  */
 char *GNUNET_STRINGS_relative_time_to_string (struct GNUNET_TIME_Relative
                                               delta);