[GNUnet-SVN] r26478 - in gnunet/src: include testbed util

[gnunet]

Author: harsha
Date: 2013-03-18 15:34:48 +0100 (Mon, 18 Mar 2013)
New Revision: 26478

Modified:
   gnunet/src/include/gnunet_pseudonym_lib.h
   gnunet/src/testbed/gnunet-service-testbed.h
   gnunet/src/testbed/gnunet-service-testbed_cache.c
   gnunet/src/testbed/gnunet-service-testbed_oc.c
   gnunet/src/testbed/gnunet_testbed_ll_master.c
   gnunet/src/testbed/gnunet_testbed_ll_monitor.c
   gnunet/src/testbed/testbed_api_operations.c
   gnunet/src/testbed/testbed_api_operations.h
   gnunet/src/testbed/testbed_api_testbed.c
   gnunet/src/util/disk.c
Log:
- doxygen



Modified: gnunet/src/include/gnunet_pseudonym_lib.h
===================================================================
--- gnunet/src/include/gnunet_pseudonym_lib.h   2013-03-18 14:01:42 UTC (rev 
26477)
+++ gnunet/src/include/gnunet_pseudonym_lib.h   2013-03-18 14:34:48 UTC (rev 
26478)
@@ -257,7 +257,7 @@
  * FS should automatically call this function.
  *
  * @param cfg overall configuration
- * @param id the pseudonym identifier
+ * @param pseudonym the pseudonym identifier
  * @param meta metadata for the pseudonym
  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
  */
@@ -362,13 +362,13 @@
  * Get the pseudonym ID belonging to the given pseudonym name.
  *
  * @param cfg configuration to use
- * @param ps_uname unique (!) human-readable name for the pseudonym
+ * @param ns_uname unique (!) human-readable name for the pseudonym
  * @param pseudonym set to pseudonym ID based on 'ns_uname'
  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
  */
 int
 GNUNET_PSEUDONYM_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                            const char *ps_uname, 
+                            const char *ns_uname,
                             struct GNUNET_PseudonymIdentifier *pseudonym);
 
 

Modified: gnunet/src/testbed/gnunet-service-testbed.h
===================================================================
--- gnunet/src/testbed/gnunet-service-testbed.h 2013-03-18 14:01:42 UTC (rev 
26477)
+++ gnunet/src/testbed/gnunet-service-testbed.h 2013-03-18 14:34:48 UTC (rev 
26478)
@@ -828,7 +828,7 @@
  * Caches the HELLO of the given peer. Updates the HELLO if it was already
  * cached before
  *
- * @param id the peer identity of the peer whose HELLO has to be cached
+ * @param peer_id the peer identity of the peer whose HELLO has to be cached
  * @param hello the HELLO message
  */
 void

Modified: gnunet/src/testbed/gnunet-service-testbed_cache.c
===================================================================
--- gnunet/src/testbed/gnunet-service-testbed_cache.c   2013-03-18 14:01:42 UTC 
(rev 26477)
+++ gnunet/src/testbed/gnunet-service-testbed_cache.c   2013-03-18 14:34:48 UTC 
(rev 26478)
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file testbed/gnunet-service-testbed_cache.h
+ * @file testbed/gnunet-service-testbed_cache.c
  * @brief testbed cache implementation
  * @author Sree Harsha Totakura
  */
@@ -299,7 +299,8 @@
 /**
  * Looks up in the cache and returns the entry
  *
- * @param id the peer identity of the peer whose corresponding entry has to be 
looked up
+ * @param key the peer identity of the peer whose corresponding entry has to be
+ *          looked up
  * @return the HELLO message; NULL if not found
  */
 static struct CacheEntry *
@@ -713,7 +714,19 @@
  * lookup in the cache; if not, a new operation is started to open the 
transport
  * handle and will be given in the callback when it is available.
  *
- * @param cls the cache entry
+ * @param peer_id the index of the peer
+ * @param cgh the CacheGetHandle
+ * @param cfg the configuration with which the transport handle has to be
+ *          created if it was not present in the cache
+ * @param target the peer identify of the peer whose connection to
+ *          TRANSPORT/CORE (depending on the type of 'cgh') subsystem will be
+ *          notified through the connect_notify_cb. Can be NULL
+ * @param connect_notify_cb the callback to call when the given target peer is
+ *          connected. This callback will only be called once or never again 
(in
+ *          case the target peer cannot be connected). Can be NULL
+ * @param connect_notify_cb_cls the closure for the above callback
+ * @return the handle which can be used to cancel or mark that the handle is no
+ *           longer being used
  */
 static struct GSTCacheGetHandle *
 cache_get_handle (unsigned int peer_id, struct GSTCacheGetHandle *cgh,
@@ -950,7 +963,7 @@
  *          connected. This callback will only be called once or never again 
(in
  *          case the target peer cannot be connected). Can be NULL
  * @param connect_notify_cb_cls the closure for the above callback
- * @return the handle which can be used cancel or mark that the handle is no
+ * @return the handle which can be used to cancel or mark that the handle is no
  *           longer being used
  */
 struct GSTCacheGetHandle *
@@ -990,7 +1003,7 @@
  *          connected. This callback will only be called once or never again 
(in
  *          case the target peer cannot be connected). Can be NULL
  * @param connect_notify_cb_cls the closure for the above callback
- * @return the handle which can be used cancel or mark that the handle is no
+ * @return the handle which can be used to cancel or mark that the handle is no
  *           longer being used
  */
 struct GSTCacheGetHandle *
@@ -1039,7 +1052,7 @@
  * Caches the HELLO of the given peer. Updates the HELLO if it was already
  * cached before
  *
- * @param id the peer identity of the peer whose HELLO has to be cached
+ * @param peer_id the peer identity of the peer whose HELLO has to be cached
  * @param hello the HELLO message
  */
 void

Modified: gnunet/src/testbed/gnunet-service-testbed_oc.c
===================================================================
--- gnunet/src/testbed/gnunet-service-testbed_oc.c      2013-03-18 14:01:42 UTC 
(rev 26477)
+++ gnunet/src/testbed/gnunet-service-testbed_oc.c      2013-03-18 14:34:48 UTC 
(rev 26478)
@@ -1357,10 +1357,8 @@
  * Function called to notify transport users that another
  * peer connected to us.
  *
- * @param cls closure
+ * @param cls the RemoteOverlayConnectContext
  * @param new_peer the peer that connected
- * @param ats performance data
- * @param ats_count number of entries in ats (excluding 0-termination)
  */
 static void
 cache_transport_peer_connect_notify (void *cls,

Modified: gnunet/src/testbed/gnunet_testbed_ll_master.c
===================================================================
--- gnunet/src/testbed/gnunet_testbed_ll_master.c       2013-03-18 14:01:42 UTC 
(rev 26477)
+++ gnunet/src/testbed/gnunet_testbed_ll_master.c       2013-03-18 14:34:48 UTC 
(rev 26478)
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file testbed/ll_master.c
+ * @file testbed/gnunet_testbed_ll_master.c
  * @brief The load level master. Creates child processes through LoadLeveler
  * @author Sree Harsha Totakura <address@hidden>
  */

Modified: gnunet/src/testbed/gnunet_testbed_ll_monitor.c
===================================================================
--- gnunet/src/testbed/gnunet_testbed_ll_monitor.c      2013-03-18 14:01:42 UTC 
(rev 26477)
+++ gnunet/src/testbed/gnunet_testbed_ll_monitor.c      2013-03-18 14:34:48 UTC 
(rev 26478)
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file testbed/ll_monitor.c
+ * @file testbed/gnunet_testbed_ll_monitor.c
  * @brief The load level monitor process. This is called whenever a job event
  *          happens. This file is called with the following syntax:
  *          "monitor_program job_id user_arg state exit_status"

Modified: gnunet/src/testbed/testbed_api_operations.c
===================================================================
--- gnunet/src/testbed/testbed_api_operations.c 2013-03-18 14:01:42 UTC (rev 
26477)
+++ gnunet/src/testbed/testbed_api_operations.c 2013-03-18 14:34:48 UTC (rev 
26478)
@@ -287,11 +287,11 @@
  *           is not empty)
  */
 int
-GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *q)
+GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *queue)
 {
-  if (NULL != q->head)
+  if (NULL != queue->head)
     return GNUNET_NO;
-  GNUNET_TESTBED_operation_queue_destroy_ (q);
+  GNUNET_TESTBED_operation_queue_destroy_ (queue);
   return GNUNET_YES;
 }
 

Modified: gnunet/src/testbed/testbed_api_operations.h
===================================================================
--- gnunet/src/testbed/testbed_api_operations.h 2013-03-18 14:01:42 UTC (rev 
26477)
+++ gnunet/src/testbed/testbed_api_operations.h 2013-03-18 14:34:48 UTC (rev 
26478)
@@ -66,7 +66,7 @@
  *           is not empty)
  */
 int
-GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *q);
+GNUNET_TESTBED_operation_queue_destroy_empty_ (struct OperationQueue *queue);
 
 
 /**

Modified: gnunet/src/testbed/testbed_api_testbed.c
===================================================================
--- gnunet/src/testbed/testbed_api_testbed.c    2013-03-18 14:01:42 UTC (rev 
26477)
+++ gnunet/src/testbed/testbed_api_testbed.c    2013-03-18 14:34:48 UTC (rev 
26478)
@@ -516,8 +516,7 @@
 /**
  * call test master callback
  *
- * @param cls the run context
- * @param tc the task context
+ * @param rc the RunContext
  */
 static void
 call_master (struct RunContext *rc)

Modified: gnunet/src/util/disk.c
===================================================================
--- gnunet/src/util/disk.c      2013-03-18 14:01:42 UTC (rev 26477)
+++ gnunet/src/util/disk.c      2013-03-18 14:34:48 UTC (rev 26478)
@@ -1921,7 +1921,7 @@
 /**
  * Get a handle from a native integer FD.
  *
- * @param fd native integer file descriptor
+ * @param fno native integer file descriptor
  * @return file handle corresponding to the descriptor
  */
 struct GNUNET_DISK_FileHandle *