gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: gnunet
Subject: [GNUnet-SVN] r28774 - gnunet/src/include
Date: Thu, 22 Aug 2013 08:28:35 +0200

Author: grothoff
Date: 2013-08-22 08:28:34 +0200 (Thu, 22 Aug 2013)
New Revision: 28774

Modified:
   gnunet/src/include/gnunet_core_service.h
   gnunet/src/include/gnunet_statistics_service.h
Log:
-doxygen fixes

Modified: gnunet/src/include/gnunet_core_service.h
===================================================================
--- gnunet/src/include/gnunet_core_service.h    2013-08-22 06:16:06 UTC (rev 
28773)
+++ gnunet/src/include/gnunet_core_service.h    2013-08-22 06:28:34 UTC (rev 
28774)
@@ -155,7 +155,7 @@
  *                messages if the client does not process them fast enough 
(for this
  *                notification type, a bounded queue is used)
  * @param inbound_hdr_only set to #GNUNET_YES if @a inbound_notify will only 
read the
- *                GNUNET_MessageHeader and hence we do not need to give it the 
full message;
+ *                `struct GNUNET_MessageHeader` and hence we do not need to 
give it the full message;
  *                can be used to improve efficiency, ignored if inbound_notify 
is NULL
  *                note that the core is allowed to drop notifications about 
inbound
  *                messages if the client does not process them fast enough 
(for this
@@ -165,7 +165,7 @@
  *                messages if the client does not process them fast enough 
(for this
  *                notification type, a bounded queue is used)
  * @param outbound_hdr_only set to #GNUNET_YES if @a outbound_notify will only 
read the
- *                GNUNET_MessageHeader and hence we do not need to give it the 
full message
+ *                `struct GNUNET_MessageHeader` and hence we do not need to 
give it the full message
  *                can be used to improve efficiency, ignored if 
outbound_notify is NULL
  *                note that the core is allowed to drop notifications about 
outbound
  *                messages if the client does not process them fast enough 
(for this
@@ -280,11 +280,8 @@
  * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
  * expected to track which peers are connected based on the connect/disconnect
  * callbacks from #GNUNET_CORE_connect.  This function is NOT part of the
- * 'versioned', 'official' API. The difference between this function and the
- * function #GNUNET_CORE_is_peer_connected is that this one returns
- * synchronously after looking in the CORE API cache. The function
- * #GNUNET_CORE_is_peer_connected sends a message to the CORE service and hence
- * its response is given asynchronously.
+ * 'versioned', 'official' API.  This function returns
+ * synchronously after looking in the CORE API cache. 
  *
  * @param h the core handle
  * @param pid the identity of the peer to check if it has been connected to us

Modified: gnunet/src/include/gnunet_statistics_service.h
===================================================================
--- gnunet/src/include/gnunet_statistics_service.h      2013-08-22 06:16:06 UTC 
(rev 28773)
+++ gnunet/src/include/gnunet_statistics_service.h      2013-08-22 06:28:34 UTC 
(rev 28774)
@@ -22,7 +22,7 @@
  * @file include/gnunet_statistics_service.h
  * @brief API to create, modify and access statistics about
  *        the operation of GNUnet; all statistical values
- *        must be of type "unsigned long long".
+ *        must be of type `unsigned long long`.
  * @author Christian Grothoff
  * @defgroup statistics track statistics or provide access to statistics
  * @{
@@ -124,8 +124,7 @@
 
 
 /**
- * Continuation called by the #GNUNET_STATISTICS_get_all
- * and #GNUNET_STATISTICS_get functions.
+ * Continuation called by #GNUNET_STATISTICS_get functions.
  *
  * @param cls closure
  * @param success #GNUNET_OK if statistics were
@@ -163,7 +162,7 @@
 
 
 /**
- * Cancel a #GNUNET_STATISICS_get request.  Must be called before the 'cont'
+ * Cancel a #GNUNET_STATISTICS_get request.  Must be called before the 'cont'
  * function is called.
  *
  * @param gh handle of the request to cancel
@@ -174,7 +173,7 @@
 
 /**
  * Set statistic value for the peer.  Will always use our
- * subsystem (the argument used when "handle" was created).
+ * subsystem (the argument used when @a handle was created).
  *
  * @param handle identification of the statistics service
  * @param name name of the statistic value
@@ -188,7 +187,7 @@
 
 /**
  * Set statistic value for the peer.  Will always use our
- * subsystem (the argument used when "handle" was created).
+ * subsystem (the argument used when @a handle was created).
  *
  * @param handle identification of the statistics service
  * @param name name of the statistic value




reply via email to

[Prev in Thread] Current Thread [Next in Thread]