-doxygen

1 files changed, 24 insertions, 26 deletions

diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h
index cec06fedd..dc64f189a 100644
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -77,12 +77,12 @@ typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
  * Functions with this signature are called whenever a message is
  * received or transmitted.
  *
- * @param cls closure (set from GNUNET_CORE_connect)
+ * @param cls closure (set from #GNUNET_CORE_connect)
  * @param peer the other peer involved (sender or receiver, NULL
  *        for loopback messages where we are both sender and receiver)
  * @param message the actual message
- * @return GNUNET_OK to keep the connection open,
- *         GNUNET_SYSERR to close connection to the peer (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ *         #GNUNET_SYSERR to close connection to the peer (signal serious error)
  */
 typedef int (*GNUNET_CORE_MessageCallback) (void *cls,
                                             const struct GNUNET_PeerIdentity *
@@ -118,16 +118,17 @@ struct GNUNET_CORE_MessageHandler
 
 
 /**
- * Function called after GNUNET_CORE_connect has succeeded (or failed
+ * Function called after #GNUNET_CORE_connect has succeeded (or failed
  * for good).  Note that the private key of the peer is intentionally
  * not exposed here; if you need it, your process should try to read
  * the private key file directly (which should work if you are
  * authorized...).  Implementations of this function must not call
- * GNUNET_CORE_disconnect (other than by scheduling a new task to
+ * #GNUNET_CORE_disconnect (other than by scheduling a new task to
  * do this later).
  *
  * @param cls closure
- * @param server handle to the server, NULL if we failed; TODO: consider removing this argument, it is redundant...
+ * @param server handle to the server, NULL if we failed;
+ *        TODO: consider removing this argument, it is redundant...
  * @param my_identity ID of this peer, NULL if we failed
  */
 typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
@@ -143,7 +144,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  * specified event happens.  The maximum number of queued
  * notifications (queue length) is per client; the queue is shared
  * across all types of notifications.  So a slow client that registers
- * for 'outbound_notify' also risks missing 'inbound_notify' messages.
+ * for @a outbound_notify also risks missing @a inbound_notify messages.
  * Certain events (such as connect/disconnect notifications) are not
  * subject to queue size limitations.
  *
@@ -157,7 +158,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  *                note that the core is allowed to drop notifications about inbound
  *                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 inbound_notify will only read the
+ * @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;
  *                can be used to improve efficiency, ignored if inbound_notify is NULL
  *                note that the core is allowed to drop notifications about inbound
@@ -167,7 +168,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  *                note that the core is allowed to drop notifications about outbound
  *                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 outbound_notify will only read the
+ * @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
  *                can be used to improve efficiency, ignored if outbound_notify is NULL
  *                note that the core is allowed to drop notifications about outbound
@@ -177,7 +178,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  *                note that the core is allowed to drop notifications about inbound
  *                messages if the client does not process them fast enough (for this
  *                notification type, a bounded queue is used)
- * @return handle to the core service (only useful for disconnect until 'init' is called),
+ * @return handle to the core service (only useful for disconnect until @a init is called),
  *           NULL on error (in this case, init is never called)
  */
 struct GNUNET_CORE_Handle *
@@ -195,7 +196,7 @@ GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 
 /**
  * Disconnect from the core service.    This function can only
- * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
+ * be called *after* all pending #GNUNET_CORE_notify_transmit_ready
  * requests have been explicitly cancelled.
  *
  * @param handle connection to core to disconnect
@@ -211,13 +212,13 @@ struct GNUNET_CORE_TransmitHandle;
 
 
 /**
- * Ask the core to call "notify" once it is ready to transmit the
- * given number of bytes to the specified "target".  Must only be
+ * Ask the core to call @a notify once it is ready to transmit the
+ * given number of bytes to the specified @a target.  Must only be
  * called after a connection to the respective peer has been
  * established (and the client has been informed about this).  You may
  * have one request of this type pending for each connected peer at
  * any time.  If a peer disconnects, the application MUST call
- * "GNUNET_CORE_notify_transmit_ready_cancel" on the respective
+ * #GNUNET_CORE_notify_transmit_ready_cancel on the respective
  * transmission request, if one such request is pending.
  *
  * @param handle connection to core service
@@ -230,7 +231,7 @@ struct GNUNET_CORE_TransmitHandle;
  *        will be called with NULL on timeout; clients MUST cancel
  *        all pending transmission requests DURING the disconnect
  *        handler
- * @param notify_cls closure for notify
+ * @param notify_cls closure for @a notify
  * @return non-NULL if the notify callback was queued,
  *         NULL if we can not even queue the request (request already pending);
  *         if NULL is returned, "notify" will NOT be called.
@@ -255,11 +256,8 @@ GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
                                           *th);
 
 
-
-
-
 /**
- * Iterate over all connected peers.  Calls peer_cb with each
+ * Iterate over all connected peers.  Calls @a peer_cb with each
  * connected peer, and then once with NULL to indicate that all peers
  * have been handled.  Normal users of the CORE API are not expected
  * to use this function.  It is different in that it truly lists
@@ -272,8 +270,8 @@ GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
  *
  * @param cfg configuration handle
  * @param peer_cb function to call with the peer information
- * @param cb_cls closure for peer_cb
- * @return GNUNET_OK on success, GNUNET_SYSERR on errors
+ * @param cb_cls closure for @a peer_cb
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on errors
  */
 int
 GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -298,7 +296,7 @@ struct GNUNET_CORE_ConnectTestHandle;
  * @param cfg configuration to use
  * @param peer the specific peer to check for
  * @param peer_cb function to call with the peer information
- * @param cb_cls closure for peer_cb
+ * @param cb_cls closure for @a peer_cb
  * @return handle to cancel the operation
  */
 struct GNUNET_CORE_ConnectTestHandle *
@@ -321,16 +319,16 @@ GNUNET_CORE_is_peer_connected_cancel (struct GNUNET_CORE_ConnectTestHandle *cth)
  * Check if the given peer is currently connected. This function is for special
  * 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
+ * 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
+ * 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
+ * #GNUNET_CORE_is_peer_connected sends a message to the CORE service and hence
  * its response is given asynchronously.
  *
  * @param h the core handle
  * @param pid the identity of the peer to check if it has been connected to us
- * @return GNUNET_YES if the peer is connected to us; GNUNET_NO if not
+ * @return #GNUNET_YES if the peer is connected to us; #GNUNET_NO if not
  */
 int
 GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,