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

[gnunet]

Author: grothoff
Date: 2013-09-21 22:14:27 +0200 (Sat, 21 Sep 2013)
New Revision: 29456

Modified:
   gnunet/src/include/gnunet_block_lib.h
   gnunet/src/include/gnunet_dht_service.h
   gnunet/src/include/gnunet_mesh_service.h
   gnunet/src/include/gnunet_signatures.h
Log:
-misc doxygen fixes

Modified: gnunet/src/include/gnunet_block_lib.h
===================================================================
--- gnunet/src/include/gnunet_block_lib.h       2013-09-21 20:14:00 UTC (rev 
29455)
+++ gnunet/src/include/gnunet_block_lib.h       2013-09-21 20:14:27 UTC (rev 
29456)
@@ -97,7 +97,7 @@
   GNUNET_BLOCK_TYPE_FS_UBLOCK = 9,
 
   /**
-   * Block for storing .gnunet-domains
+   * Block for storing DNS exit service advertisements.
    */
   GNUNET_BLOCK_TYPE_DNS = 10,
 

Modified: gnunet/src/include/gnunet_dht_service.h
===================================================================
--- gnunet/src/include/gnunet_dht_service.h     2013-09-21 20:14:00 UTC (rev 
29455)
+++ gnunet/src/include/gnunet_dht_service.h     2013-09-21 20:14:27 UTC (rev 
29456)
@@ -70,21 +70,21 @@
  */
 enum GNUNET_DHT_RouteOption
 {
-    /**
-     * Default.  Do nothing special.
-     */
+  /**
+   * Default.  Do nothing special.
+   */
   GNUNET_DHT_RO_NONE = 0,
 
-    /**
-     * Each peer along the way should look at 'enc' (otherwise
-     * only the k-peers closest to the key should look at it).
-     */
+  /**
+   * Each peer along the way should look at 'enc' (otherwise
+   * only the k-peers closest to the key should look at it).
+   */
   GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1,
 
-    /**
-     * We should keep track of the route that the message
-     * took in the P2P network.
-     */
+  /**
+   * We should keep track of the route that the message
+   * took in the P2P network.
+   */
   GNUNET_DHT_RO_RECORD_ROUTE = 2,
 
   /**
@@ -92,9 +92,9 @@
    */
   GNUNET_DHT_RO_FIND_PEER = 4,
 
-    /**
-     * Possible message option for query key randomization.
-     */
+  /**
+   * Possible message option for query key randomization.
+   */
   GNUNET_DHT_RO_BART = 8
 };
 
@@ -154,19 +154,19 @@
  *                nearest peers this request should reach
  * @param options routing options for this message
  * @param type type of the value
- * @param size number of bytes in data; must be less than 64k
+ * @param size number of bytes in @a data; must be less than 64k
  * @param data the data to store
  * @param exp desired expiration time for the value
  * @param timeout how long to wait for transmission of this request
  * @param cont continuation to call when done (transmitting request to service)
- *        You must not call "GNUNET_DHT_disconnect" in this continuation
- * @param cont_cls closure for cont
+ *        You must not call #GNUNET_DHT_disconnect in this continuation
+ * @param cont_cls closure for @a cont
  * @return handle to cancel the "PUT" operation, NULL on error
  *        (size too big)
  */
 struct GNUNET_DHT_PutHandle *
 GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, 
-                const struct GNUNET_HashCode * key,
+                const struct GNUNET_HashCode *key,
                 uint32_t desired_replication_level,
                 enum GNUNET_DHT_RouteOption options,
                 enum GNUNET_BLOCK_Type type,
@@ -183,7 +183,7 @@
  * has not yet been sent to the service, cancelling the PUT will stop
  * this from happening (but there is no way for the user of this API
  * to tell if that is the case).  The only use for this API is to 
- * prevent a later call to 'cont' from "GNUNET_DHT_put" (i.e. because
+ * prevent a later call to 'cont' from #GNUNET_DHT_put (i.e. because
  * the system is shutting down).
  *
  * @param ph put operation to cancel ('cont' will no longer be called)
@@ -201,29 +201,28 @@
  * @param key key of the result
  * @param get_path peers on reply path (or NULL if not recorded)
  *                 [0] = datastore's first neighbor, [length - 1] = local peer
- * @param get_path_length number of entries in get_path
+ * @param get_path_length number of entries in @a get_path
  * @param put_path peers on the PUT path (or NULL if not recorded)
  *                 [0] = origin, [length - 1] = datastore
- * @param put_path_length number of entries in get_path
+ * @param put_path_length number of entries in @a put_path
  * @param type type of the result
- * @param size number of bytes in data
+ * @param size number of bytes in @a data
  * @param data pointer to the result data
  */
 typedef void (*GNUNET_DHT_GetIterator) (void *cls,
                                         struct GNUNET_TIME_Absolute exp,
-                                        const struct GNUNET_HashCode * key,
-                                        const struct GNUNET_PeerIdentity *
-                                        get_path, unsigned int get_path_length,
-                                        const struct GNUNET_PeerIdentity *
-                                        put_path, unsigned int put_path_length,
+                                        const struct GNUNET_HashCode *key,
+                                        const struct GNUNET_PeerIdentity 
*get_path, 
+                                       unsigned int get_path_length,
+                                        const struct GNUNET_PeerIdentity 
*put_path, 
+                                       unsigned int put_path_length,
                                         enum GNUNET_BLOCK_Type type,
                                         size_t size, const void *data);
 
 
-
 /**
  * Perform an asynchronous GET operation on the DHT identified. See
- * also "GNUNET_BLOCK_evaluate".
+ * also #GNUNET_BLOCK_evaluate.
  *
  * @param handle handle to the DHT service
  * @param type expected type of the response object
@@ -232,9 +231,9 @@
                   nearest peers this request should reach
  * @param options routing options for this message
  * @param xquery extended query data (can be NULL, depending on type)
- * @param xquery_size number of bytes in xquery
+ * @param xquery_size number of bytes in @a xquery
  * @param iter function to call on each result
- * @param iter_cls closure for iter
+ * @param iter_cls closure for @a iter
  *
  * @return handle to stop the async get
  */
@@ -254,7 +253,7 @@
  *
  * @param get_handle get operation for which results should be filtered
  * @param num_results number of results to be blocked that are
- *        provided in this call (size of the 'results' array)
+ *        provided in this call (size of the @a results array)
  * @param results array of hash codes over the 'data' of the results
  *        to be blocked
  */
@@ -289,7 +288,7 @@
  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
  * @param type The type of data in the request.
  * @param hop_count Hop count so far.
- * @param path_length number of entries in path (or 0 if not recorded).
+ * @param path_length number of entries in @a path (or 0 if not recorded).
  * @param path peers on the GET path (or NULL if not recorded).
  * @param desired_replication_level Desired replication level.
  * @param key Key of the requested data.
@@ -309,24 +308,22 @@
  * @param cls Closure.
  * @param type The type of data in the result.
  * @param get_path Peers on GET path (or NULL if not recorded).
- * @param get_path_length number of entries in get_path.
+ * @param get_path_length number of entries in @a get_path.
  * @param put_path peers on the PUT path (or NULL if not recorded).
- * @param put_path_length number of entries in get_path.
+ * @param put_path_length number of entries in @a get_path.
  * @param exp Expiration time of the data.
  * @param key Key of the data.
  * @param data Pointer to the result data.
- * @param size Number of bytes in data.
+ * @param size Number of bytes in @a data.
  */
 typedef void (*GNUNET_DHT_MonitorGetRespCB) (void *cls,
                                              enum GNUNET_BLOCK_Type type,
-                                             const struct GNUNET_PeerIdentity
-                                             *get_path,
+                                             const struct GNUNET_PeerIdentity 
*get_path,
                                              unsigned int get_path_length,
-                                             const struct GNUNET_PeerIdentity
-                                             * put_path,
+                                             const struct GNUNET_PeerIdentity 
*put_path,
                                              unsigned int put_path_length,
                                              struct GNUNET_TIME_Absolute exp,
-                                             const struct GNUNET_HashCode * 
key,
+                                             const struct GNUNET_HashCode *key,
                                              const void *data,
                                              size_t size);
 
@@ -337,7 +334,7 @@
  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
  * @param type The type of data in the request.
  * @param hop_count Hop count so far.
- * @param path_length number of entries in path (or 0 if not recorded).
+ * @param path_length number of entries in @a path (or 0 if not recorded).
  * @param path peers on the PUT path (or NULL if not recorded).
  * @param desired_replication_level Desired replication level.
  * @param exp Expiration time of the data.
@@ -353,7 +350,7 @@
                                          unsigned int path_length,
                                          const struct GNUNET_PeerIdentity 
*path,
                                          struct GNUNET_TIME_Absolute exp,
-                                         const struct GNUNET_HashCode * key,
+                                         const struct GNUNET_HashCode *key,
                                          const void *data,
                                          size_t size);
 
@@ -366,8 +363,7 @@
  * @param get_cb Callback to process monitored get messages.
  * @param get_resp_cb Callback to process monitored get response messages.
  * @param put_cb Callback to process monitored put messages.
- * @param cb_cls Closure for cb.
- *
+ * @param cb_cls Closure for callbacks
  * @return Handle to stop monitoring.
  */
 struct GNUNET_DHT_MonitorHandle *
@@ -382,10 +378,9 @@
 
 /**
  * Stop monitoring.
+ * On return handle will no longer be valid, caller must not use again!!!
  *
  * @param handle The handle to the monitor request returned by monitor_start.
- *
- * On return handle will no longer be valid, caller must not use again!!!
  */
 void
 GNUNET_DHT_monitor_stop (struct GNUNET_DHT_MonitorHandle *handle);

Modified: gnunet/src/include/gnunet_mesh_service.h
===================================================================
--- gnunet/src/include/gnunet_mesh_service.h    2013-09-21 20:14:00 UTC (rev 
29455)
+++ gnunet/src/include/gnunet_mesh_service.h    2013-09-21 20:14:27 UTC (rev 
29456)
@@ -105,8 +105,8 @@
  * @param tunnel_ctx Place to store local state associated with the tunnel.
  * @param message The actual message.
  * 
- * @return GNUNET_OK to keep the tunnel open,
- *         GNUNET_SYSERR to close it (signal serious error).
+ * @return #GNUNET_OK to keep the tunnel open,
+ *         #GNUNET_SYSERR to close it (signal serious error).
  */
 typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
                                             struct GNUNET_MESH_Tunnel *tunnel,
@@ -143,7 +143,7 @@
  * Method called whenever another peer has added us to a tunnel
  * the other peer initiated.
  * Only called (once) upon reception of data with a message type which was
- * subscribed to in GNUNET_MESH_connect. A call to GNUNET_MESH_tunnel_destroy
+ * subscribed to in #GNUNET_MESH_connect. A call to #GNUNET_MESH_tunnel_destroy
  * causes te tunnel to be ignored and no further notifications are sent about
  * the same tunnel.
  *
@@ -168,9 +168,9 @@
  * Function called whenever a tunnel is destroyed.  Should clean up
  * any associated state. 
  * 
- * It must NOT call GNUNET_MESH_tunnel_destroy on the tunnel.
+ * It must NOT call #GNUNET_MESH_tunnel_destroy on the tunnel.
  *
- * @param cls closure (set from GNUNET_MESH_connect)
+ * @param cls closure (set from #GNUNET_MESH_connect)
  * @param tunnel connection to the other end (henceforth invalid)
  * @param tunnel_ctx place where local state associated
  *                   with the tunnel is stored
@@ -232,7 +232,6 @@
  * @param port Port number.
  * @param nobuffer Flag for disabling buffering on relay nodes.
  * @param reliable Flag for end-to-end reliability.
- *
  * @return handle to the tunnel
  */
 struct GNUNET_MESH_Tunnel *
@@ -295,7 +294,7 @@
 
 
 /**
- * Ask the mesh to call "notify" once it is ready to transmit the
+ * Ask the mesh to call @a notify once it is ready to transmit the
  * given number of bytes to the specified tunnel.
  * Only one call can be active at any time, to issue another request,
  * wait for the callback or cancel the current request.
@@ -303,12 +302,12 @@
  * @param tunnel tunnel to use for transmission
  * @param cork is corking allowed for this transmission?
  * @param maxdelay how long can the message wait?
- * @param notify_size how many bytes of buffer space does notify want?
+ * @param notify_size how many bytes of buffer space does @a notify want?
  * @param notify function to call when buffer space is available;
  *        will be called with NULL on timeout or if the overall queue
  *        for this peer is larger than queue_size and this is currently
  *        the message with the lowest priority
- * @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 (insufficient
  *         memory); if NULL is returned, "notify" will NOT be called.
@@ -411,7 +410,7 @@
  * @param initiator ID of the owner of the tunnel.
  * @param tunnel_number Tunnel number.
  * @param callback Function to call with the requested data.
- * @param callback_cls Closure for @c callback.
+ * @param callback_cls Closure for @a callback.
  */
 void
 GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,

Modified: gnunet/src/include/gnunet_signatures.h
===================================================================
--- gnunet/src/include/gnunet_signatures.h      2013-09-21 20:14:00 UTC (rev 
29455)
+++ gnunet/src/include/gnunet_signatures.h      2013-09-21 20:14:27 UTC (rev 
29456)
@@ -91,7 +91,7 @@
 #define GNUNET_SIGNATURE_PURPOSE_RESOLVER_RESPONSE 10
 
 /**
- * Signature of an GNUNET_DNS_Record
+ * Signature of an GNUNET_DNS_Advertisement
  */
 #define GNUNET_SIGNATURE_PURPOSE_DNS_RECORD 11