[GNUnet-SVN] r8979 - in gnunet/src: arm datacache datastore fs include transport upnp util

[gnunet]

Author: grothoff
Date: 2009-09-11 05:26:42 -0600 (Fri, 11 Sep 2009)
New Revision: 8979

Modified:
   gnunet/src/arm/arm_api.c
   gnunet/src/datacache/datacache.c
   gnunet/src/datacache/plugin_datacache.h
   gnunet/src/datacache/plugin_datacache_sqlite.c
   gnunet/src/datacache/plugin_datacache_template.c
   gnunet/src/datastore/datastore_api.c
   gnunet/src/datastore/gnunet-service-datastore.c
   gnunet/src/fs/gnunet-service-fs.c
   gnunet/src/include/gnunet_fs_service.h
   gnunet/src/include/gnunet_getopt_lib.h
   gnunet/src/include/winproc.h
   gnunet/src/transport/gnunet-transport.c
   gnunet/src/transport/plugin_transport_http.c
   gnunet/src/transport/plugin_transport_smtp.c
   gnunet/src/transport/plugin_transport_udp.c
   gnunet/src/upnp/upnp_init.c
   gnunet/src/upnp/upnp_ip.c
   gnunet/src/upnp/upnp_ip.h
   gnunet/src/upnp/upnp_util.h
   gnunet/src/upnp/upnp_xmlnode.c
   gnunet/src/upnp/upnp_xmlnode.h
   gnunet/src/util/common_allocation.c
   gnunet/src/util/network.c
   gnunet/src/util/os_load.c
   gnunet/src/util/os_priority.c
   gnunet/src/util/scheduler.c
   gnunet/src/util/win.cc
   gnunet/src/util/winproc.c
Log:
fixing docu issues

Modified: gnunet/src/arm/arm_api.c
===================================================================
--- gnunet/src/arm/arm_api.c    2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/arm/arm_api.c    2009-09-11 11:26:42 UTC (rev 8979)
@@ -33,18 +33,52 @@
 #include "arm.h"
 
 
+/**
+ * FIXME: document.
+ */
 struct ArmContext
 {
+
+  /**
+   * FIXME: document.
+   */
   GNUNET_ARM_Callback callback;
+
+  /**
+   * FIXME: document.
+   */
   void *cls;
+
+  /**
+   * FIXME: document.
+   */
   char *service_name;
+
+  /**
+   * FIXME: document.
+   */
   struct GNUNET_CLIENT_Connection *client;
+
+  /**
+   * FIXME: document.
+   */
   const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+  /**
+   * FIXME: document.
+   */
   struct GNUNET_TIME_Absolute timeout;
+
+  /**
+   * FIXME: document.
+   */
   uint16_t type;
 };
 
 
+/**
+ * FIXME: document.
+ */
 static void
 arm_service_report (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
@@ -192,6 +226,7 @@
  * @param timeout how long to wait before failing for good
  * @param cb callback to invoke when service is ready
  * @param cb_cls closure for callback
+ * @param type type of the request 
  */
 static void
 change_service (const char *service_name,

Modified: gnunet/src/datacache/datacache.c
===================================================================
--- gnunet/src/datacache/datacache.c    2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/datacache/datacache.c    2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file datacache/datacache_api.c
+ * @file datacache/datacache.c
  * @brief datacache API implementation
  * @author Christian Grothoff
  */

Modified: gnunet/src/datacache/plugin_datacache.h
===================================================================
--- gnunet/src/datacache/plugin_datacache.h     2009-09-11 09:09:39 UTC (rev 
8978)
+++ gnunet/src/datacache/plugin_datacache.h     2009-09-11 11:26:42 UTC (rev 
8979)
@@ -105,7 +105,7 @@
   /**
    * Store an item in the datastore.
    *
-   * @param key key to store data under
+   * @param cls closure (internal context for the plugin)
    * @param size number of bytes in data
    * @param data data to store
    * @param type type of the value
@@ -124,9 +124,11 @@
    * Iterate over the results for a particular key
    * in the datastore.
    *
+   * @param cls closure (internal context for the plugin)
    * @param key
    * @param type entries of which type are relevant?
    * @param iter maybe NULL (to just count)
+   * @param iter_cls closure for iter
    * @return the number of results found
    */
   unsigned int (*get) (void *cls,
@@ -140,6 +142,7 @@
    * Delete the entry with the lowest expiration value
    * from the datacache right now.
    * 
+   * @param cls closure (internal context for the plugin)
    * @return GNUNET_OK on success, GNUNET_SYSERR on error
    */ 
   int (*del) (void *cls);

Modified: gnunet/src/datacache/plugin_datacache_sqlite.c
===================================================================
--- gnunet/src/datacache/plugin_datacache_sqlite.c      2009-09-11 09:09:39 UTC 
(rev 8978)
+++ gnunet/src/datacache/plugin_datacache_sqlite.c      2009-09-11 11:26:42 UTC 
(rev 8979)
@@ -86,6 +86,7 @@
 /**
  * Store an item in the datastore.
  *
+ * @param cls closure (our "struct Plugin")
  * @param key key to store data under
  * @param size number of bytes in data
  * @param data data to store
@@ -155,9 +156,11 @@
  * Iterate over the results for a particular key
  * in the datastore.
  *
+ * @param cls closure (our "struct Plugin")
  * @param key
  * @param type entries of which type are relevant?
  * @param iter maybe NULL (to just count)
+ * @param iter_cls closure for iter
  * @return the number of results found
  */
 static unsigned int 
@@ -259,6 +262,7 @@
  * Delete the entry with the lowest expiration value
  * from the datacache right now.
  * 
+ * @param cls closure (our "struct Plugin")
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */ 
 static int 
@@ -337,6 +341,9 @@
 
 /**
  * Entry point for the plugin.
+ *
+ * @param cls closure (the "struct GNUNET_DATACACHE_PluginEnvironmnet")
+ * @return the plugin's closure (our "struct Plugin")
  */
 void *
 libgnunet_plugin_datacache_sqlite_init (void *cls)
@@ -398,6 +405,9 @@
 
 /**
  * Exit point from the plugin.
+ *
+ * @param cls closure (our "struct Plugin")
+ * @return NULL
  */
 void *
 libgnunet_plugin_datacache_sqlite_done (void *cls)

Modified: gnunet/src/datacache/plugin_datacache_template.c
===================================================================
--- gnunet/src/datacache/plugin_datacache_template.c    2009-09-11 09:09:39 UTC 
(rev 8978)
+++ gnunet/src/datacache/plugin_datacache_template.c    2009-09-11 11:26:42 UTC 
(rev 8979)
@@ -43,6 +43,7 @@
 /**
  * Store an item in the datastore.
  *
+ * @param cls closure (our "struct Plugin")
  * @param key key to store data under
  * @param size number of bytes in data
  * @param data data to store
@@ -67,9 +68,11 @@
  * Iterate over the results for a particular key
  * in the datastore.
  *
+ * @param cls closure (our "struct Plugin")
  * @param key
  * @param type entries of which type are relevant?
  * @param iter maybe NULL (to just count)
+ * @param iter_cls closure for iter
  * @return the number of results found
  */
 static unsigned int 
@@ -88,6 +91,7 @@
  * Delete the entry with the lowest expiration value
  * from the datacache right now.
  * 
+ * @param cls closure (our "struct Plugin")
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */ 
 static int 
@@ -100,6 +104,9 @@
 
 /**
  * Entry point for the plugin.
+ *
+ * @param cls closure (the "struct GNUNET_DATACACHE_PluginEnvironmnet")
+ * @return the plugin's closure (our "struct Plugin")
  */
 void *
 libgnunet_plugin_datacache_template_init (void *cls)
@@ -123,6 +130,9 @@
 
 /**
  * Exit point from the plugin.
+ *
+ * @param cls closure (our "struct Plugin")
+ * @return NULL
  */
 void *
 libgnunet_plugin_datacache_template_done (void *cls)

Modified: gnunet/src/datastore/datastore_api.c
===================================================================
--- gnunet/src/datastore/datastore_api.c        2009-09-11 09:09:39 UTC (rev 
8978)
+++ gnunet/src/datastore/datastore_api.c        2009-09-11 11:26:42 UTC (rev 
8979)
@@ -335,6 +335,8 @@
  * lower anonymity level is used.
  *
  * @param h handle to the datastore
+ * @param rid reservation ID to use (from "reserve"); use 0 if no
+ *            prior reservation was made
  * @param key key for the value
  * @param size number of bytes in data
  * @param data content stored

Modified: gnunet/src/datastore/gnunet-service-datastore.c
===================================================================
--- gnunet/src/datastore/gnunet-service-datastore.c     2009-09-11 09:09:39 UTC 
(rev 8978)
+++ gnunet/src/datastore/gnunet-service-datastore.c     2009-09-11 11:26:42 UTC 
(rev 8979)
@@ -456,6 +456,8 @@
  *
  * @param client target of the message
  * @param msg message to transmit, will be freed!
+ * @param tc function to call afterwards
+ * @param tc_cls closure for tc
  * @param end is this the last response (and we should
  *        signal the server completion accodingly after
  *        transmitting this message)?
@@ -537,7 +539,7 @@
  * Function called once the transmit operation has
  * either failed or succeeded.
  *
- * @param cls closure
+ * @param next_cls closure for calling "next_request" callback
  * @param status GNUNET_OK on success, GNUNET_SYSERR on error
  */
 static void 

Modified: gnunet/src/fs/gnunet-service-fs.c
===================================================================
--- gnunet/src/fs/gnunet-service-fs.c   2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/fs/gnunet-service-fs.c   2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file statistics/gnunet-service-fs.c
+ * @file fs/gnunet-service-fs.c
  * @brief program that provides the file-sharing service
  * @author Christian Grothoff
  */

Modified: gnunet/src/include/gnunet_fs_service.h
===================================================================
--- gnunet/src/include/gnunet_fs_service.h      2009-09-11 09:09:39 UTC (rev 
8978)
+++ gnunet/src/include/gnunet_fs_service.h      2009-09-11 11:26:42 UTC (rev 
8979)
@@ -382,7 +382,9 @@
  * Construct a keyword-URI from meta-data (take all entries
  * in the meta-data and construct one large keyword URI
  * that lists all keywords that can be found in the meta-data).
- * @deprecated
+ *
+ * @param md metadata to use
+ * @return NULL on error, otherwise a KSK URI
  */
 struct GNUNET_FS_Uri *
 GNUNET_FS_uri_ksk_create_from_meta_data (const struct 
GNUNET_CONTAINER_MetaData *md);

Modified: gnunet/src/include/gnunet_getopt_lib.h
===================================================================
--- gnunet/src/include/gnunet_getopt_lib.h      2009-09-11 09:09:39 UTC (rev 
8978)
+++ gnunet/src/include/gnunet_getopt_lib.h      2009-09-11 11:26:42 UTC (rev 
8979)
@@ -99,7 +99,7 @@
 {
 
   /**
-   * Short name of the option (use '\0' for none).
+   * Short name of the option (use '\\0' for none).
    */
   const char shortName;
 

Modified: gnunet/src/include/winproc.h
===================================================================
--- gnunet/src/include/winproc.h        2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/include/winproc.h        2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,10 +19,10 @@
 */
 
 /**
- * @file util/winproc.h
+ * @file include/winproc.h
  * @brief Definitions for MS Windows
  * @author Nils Durner
- **/
+ */
 
 #ifndef _WINPROC_H
 #define _WINPROC_H

Modified: gnunet/src/transport/gnunet-transport.c
===================================================================
--- gnunet/src/transport/gnunet-transport.c     2009-09-11 09:09:39 UTC (rev 
8978)
+++ gnunet/src/transport/gnunet-transport.c     2009-09-11 11:26:42 UTC (rev 
8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file server/gnunet-transport.c
+ * @file src/transport/gnunet-transport.c
  * @brief Tool to help configure the transports.
  * @author Christian Grothoff
  *

Modified: gnunet/src/transport/plugin_transport_http.c
===================================================================
--- gnunet/src/transport/plugin_transport_http.c        2009-09-11 09:09:39 UTC 
(rev 8978)
+++ gnunet/src/transport/plugin_transport_http.c        2009-09-11 11:26:42 UTC 
(rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file transports/http.c
+ * @file transport/plugin_transport_http.c
  * @brief Implementation of the HTTP transport service
  * @author Christian Grothoff
  */

Modified: gnunet/src/transport/plugin_transport_smtp.c
===================================================================
--- gnunet/src/transport/plugin_transport_smtp.c        2009-09-11 09:09:39 UTC 
(rev 8978)
+++ gnunet/src/transport/plugin_transport_smtp.c        2009-09-11 11:26:42 UTC 
(rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file transports/smtp.c
+ * @file transport/plugin_transport_smtp.c
  * @brief Implementation of the SMTP transport service
  * @author Christian Grothoff
  * @author Renaldo Ferreira

Modified: gnunet/src/transport/plugin_transport_udp.c
===================================================================
--- gnunet/src/transport/plugin_transport_udp.c 2009-09-11 09:09:39 UTC (rev 
8978)
+++ gnunet/src/transport/plugin_transport_udp.c 2009-09-11 11:26:42 UTC (rev 
8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file transports/udp.c
+ * @file transport/plugin_transport_udp.c
  * @brief Implementation of the UDP transport service
  * @author Christian Grothoff
  */

Modified: gnunet/src/upnp/upnp_init.c
===================================================================
--- gnunet/src/upnp/upnp_init.c 2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/upnp/upnp_init.c 2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file src/transports/upnp/init.c
+ * @file transport/upnp_init.c
  * @brief API for UPnP access
  * @author Christian Grothoff
  */

Modified: gnunet/src/upnp/upnp_ip.c
===================================================================
--- gnunet/src/upnp/upnp_ip.c   2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/upnp/upnp_ip.c   2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file transports/upnp/ip.c
+ * @file transport/upnp_ip.c
  * @brief code to determine the IP of the local machine
  *
  * @author Christian Grothoff

Modified: gnunet/src/upnp/upnp_ip.h
===================================================================
--- gnunet/src/upnp/upnp_ip.h   2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/upnp/upnp_ip.h   2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file transports/upnp/ip.h
+ * @file transport/upnp_ip.h
  * @brief
  *
  * @author Christian Grothoff

Modified: gnunet/src/upnp/upnp_util.h
===================================================================
--- gnunet/src/upnp/upnp_util.h 2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/upnp/upnp_util.h 2009-09-11 11:26:42 UTC (rev 8979)
@@ -1,5 +1,5 @@
 /**
- * @file util.h Utility Functions
+ * @file transport/upnp_util.h Utility Functions
  * @ingroup core
  *
  * gaim

Modified: gnunet/src/upnp/upnp_xmlnode.c
===================================================================
--- gnunet/src/upnp/upnp_xmlnode.c      2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/upnp/upnp_xmlnode.c      2009-09-11 11:26:42 UTC (rev 8979)
@@ -1,5 +1,5 @@
 /**
- * @file xmlnode.c XML DOM functions
+ * @file transport/upnp_xmlnode.c XML DOM functions
  *
  * gaim
  *

Modified: gnunet/src/upnp/upnp_xmlnode.h
===================================================================
--- gnunet/src/upnp/upnp_xmlnode.h      2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/upnp/upnp_xmlnode.h      2009-09-11 11:26:42 UTC (rev 8979)
@@ -1,5 +1,5 @@
 /**
- * @file xmlnode.h XML DOM functions
+ * @file transport/upnp_xmlnode.h XML DOM functions
  * @ingroup core
  *
  * gaim

Modified: gnunet/src/util/common_allocation.c
===================================================================
--- gnunet/src/util/common_allocation.c 2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/common_allocation.c 2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file util/memory/common_allocation.c
+ * @file util/common_allocation.c
  * @brief wrapper around malloc/free
  * @author Christian Grothoff
  */

Modified: gnunet/src/util/network.c
===================================================================
--- gnunet/src/util/network.c   2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/network.c   2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file util/sock.c
+ * @file util/network.c
  * @brief basic, low-level networking interface
  * @author Nils Durner
  */
@@ -821,4 +821,4 @@
 #endif
 }
 
-/* end of network_socket.c */
+/* end of network.c */

Modified: gnunet/src/util/os_load.c
===================================================================
--- gnunet/src/util/os_load.c   2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/os_load.c   2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file util/os_load_cpu.c
+ * @file util/os_load.c
  * @brief calls to determine current CPU load
  * @author Tzvetan Horozov
  * @author Christian Grothoff
@@ -650,4 +650,4 @@
 }
 
 
-/* end of os_load_cpu.c */
+/* end of os_load.c */

Modified: gnunet/src/util/os_priority.c
===================================================================
--- gnunet/src/util/os_priority.c       2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/os_priority.c       2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file util/os/priority.c
+ * @file util/os_priority.c
  * @brief Methods to set process priority
  * @author Nils Durner
  */

Modified: gnunet/src/util/scheduler.c
===================================================================
--- gnunet/src/util/scheduler.c 2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/scheduler.c 2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file util/scheduler/scheduler.c
+ * @file util/scheduler.c
  * @brief schedule computations using continuation passing style
  * @author Christian Grothoff
  */

Modified: gnunet/src/util/win.cc
===================================================================
--- gnunet/src/util/win.cc      2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/win.cc      2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,10 +19,10 @@
 */
 
 /**
- * @file util/win/win.cc
+ * @file util/win.cc
  * @brief Helper functions for MS Windows in C++
  * @author Nils Durner
- **/
+ */
 
 #ifndef _WIN_CC
 #define _WIN_CC

Modified: gnunet/src/util/winproc.c
===================================================================
--- gnunet/src/util/winproc.c   2009-09-11 09:09:39 UTC (rev 8978)
+++ gnunet/src/util/winproc.c   2009-09-11 11:26:42 UTC (rev 8979)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file util/win/winproc.c
+ * @file util/winproc.c
  * @brief Functions for MS Windows
  * @author Nils Durner
  */