[GNUnet-SVN] r32902 - in gnunet/src: core include util

[gnunet]

Author: grothoff
Date: 2014-04-07 11:19:28 +0200 (Mon, 07 Apr 2014)
New Revision: 32902

Modified:
   gnunet/src/core/gnunet-service-core_clients.c
   gnunet/src/core/gnunet-service-core_kx.c
   gnunet/src/core/gnunet-service-core_kx.h
   gnunet/src/core/gnunet-service-core_neighbours.c
   gnunet/src/core/gnunet-service-core_sessions.c
   gnunet/src/include/gnunet_protocols.h
   gnunet/src/util/os_priority.c
Log:
-doxygen improvements

Modified: gnunet/src/core/gnunet-service-core_clients.c
===================================================================
--- gnunet/src/core/gnunet-service-core_clients.c       2014-04-07 09:18:17 UTC 
(rev 32901)
+++ gnunet/src/core/gnunet-service-core_clients.c       2014-04-07 09:19:28 UTC 
(rev 32902)
@@ -43,7 +43,7 @@
 
 
 /**
- * Data structure for each client connected to the core service.
+ * Data structure for each client connected to the CORE service.
  */
 struct GSC_Client
 {
@@ -64,14 +64,14 @@
 
   /**
    * Array of the types of messages this peer cares
-   * about (with "tcnt" entries).  Allocated as part
+   * about (with @e tcnt entries).  Allocated as part
    * of this client struct, do not free!
    */
   const uint16_t *types;
 
   /**
    * Map of peer identities to active transmission requests of this
-   * client to the peer (of type 'struct GSC_ClientActiveRequest').
+   * client to the peer (of type `struct GSC_ClientActiveRequest`).
    */
   struct GNUNET_CONTAINER_MultiPeerMap *requests;
 
@@ -88,7 +88,7 @@
 
   /**
    * Number of types of incoming messages this client
-   * specifically cares about.  Size of the "types" array.
+   * specifically cares about.  Size of the @e types array.
    */
   unsigned int tcnt;
 
@@ -190,7 +190,7 @@
  *
  * @param type message type
  * @param c client to test
- * @return GNUNET_YES if 'c' is interested, GNUNET_NO if not.
+ * @return #GNUNET_YES if @a c is interested, #GNUNET_NO if not.
  */
 static int
 type_match (uint16_t type, struct GSC_Client *c)
@@ -225,7 +225,7 @@
   struct GSC_Client *c;
   int tm;
 
-  for (c = client_head; c != NULL; c = c->next)
+  for (c = client_head; NULL != c; c = c->next)
   {
     tm = type_match (type, c);
     if (!  ( (0 != (c->options & options)) ||
@@ -408,7 +408,7 @@
 
 
 /**
- * Closure for the 'client_tokenizer_callback'.
+ * Closure for the #client_tokenizer_callback().
  */
 struct TokenizerContext
 {
@@ -436,7 +436,7 @@
  *
  * @param cls unused
  * @param client the client issuing the request
- * @param message the "struct SendMessage"
+ * @param message the `struct SendMessage`
  */
 static void
 handle_client_send (void *cls, struct GNUNET_SERVER_Client *client,

Modified: gnunet/src/core/gnunet-service-core_kx.c
===================================================================
--- gnunet/src/core/gnunet-service-core_kx.c    2014-04-07 09:18:17 UTC (rev 
32901)
+++ gnunet/src/core/gnunet-service-core_kx.c    2014-04-07 09:19:28 UTC (rev 
32902)
@@ -77,7 +77,7 @@
 {
 
   /**
-   * Message type is CORE_EPHEMERAL_KEY.
+   * Message type is #GNUNET_MESSAGE_TYPE_CORE_EPHEMERAL_KEY.
    */
   struct GNUNET_MessageHeader header;
 
@@ -128,7 +128,7 @@
 struct PingMessage
 {
   /**
-   * Message type is CORE_PING.
+   * Message type is #GNUNET_MESSAGE_TYPE_CORE_PING.
    */
   struct GNUNET_MessageHeader header;
 
@@ -156,7 +156,7 @@
 struct PongMessage
 {
   /**
-   * Message type is CORE_PONG.
+   * Message type is #GNUNET_MESSAGE_TYPE_CORE_PONG.
    */
   struct GNUNET_MessageHeader header;
 
@@ -191,7 +191,7 @@
 struct EncryptedMessage
 {
   /**
-   * Message type is either CORE_ENCRYPTED_MESSAGE.
+   * Message type is either #GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE.
    */
   struct GNUNET_MessageHeader header;
 
@@ -509,15 +509,15 @@
 
 
 /**
- * Encrypt size bytes from in and write the result to out.  Use the
- * key for outbound traffic of the given neighbour.
+ * Encrypt size bytes from @a in and write the result to @a out.  Use the
+ * @a kx key for outbound traffic of the given neighbour.
  *
  * @param kx key information context
  * @param iv initialization vector to use
  * @param in ciphertext
  * @param out plaintext
- * @param size size of in/out
- * @return GNUNET_OK on success
+ * @param size size of @a in/@a out
+ * @return #GNUNET_OK on success
  */
 static int
 do_encrypt (struct GSC_KeyExchangeInfo *kx,
@@ -549,8 +549,8 @@
 
 
 /**
- * Decrypt size bytes from in and write the result to out.  Use the
- * key for inbound traffic of the given neighbour.  This function does
+ * Decrypt size bytes from @a in and write the result to @a out.  Use the
+ * @a kx key for inbound traffic of the given neighbour.  This function does
  * NOT do any integrity-checks on the result.
  *
  * @param kx key information context
@@ -609,13 +609,14 @@
 
 
 /**
- * Task that will retry "send_key" if our previous attempt failed.
+ * Task that will retry #send_key() if our previous attempt failed.
  *
- * @param cls our 'struct GSC_KeyExchangeInfo'
+ * @param cls our `struct GSC_KeyExchangeInfo`
  * @param tc scheduler context
  */
 static void
-set_key_retry_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+set_key_retry_task (void *cls,
+                    const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GSC_KeyExchangeInfo *kx = cls;
 
@@ -694,7 +695,7 @@
     /* peer with "higher" identity starts a delayed  KX, if the "lower" peer
      * does not start a KX since he sees no reasons to do so  */
     kx->retry_set_key_task = GNUNET_SCHEDULER_add_delayed 
(GNUNET_TIME_UNIT_SECONDS,
-          &set_key_retry_task, kx);
+                                                           
&set_key_retry_task, kx);
   }
   return kx;
 }

Modified: gnunet/src/core/gnunet-service-core_kx.h
===================================================================
--- gnunet/src/core/gnunet-service-core_kx.h    2014-04-07 09:18:17 UTC (rev 
32901)
+++ gnunet/src/core/gnunet-service-core_kx.h    2014-04-07 09:19:28 UTC (rev 
32902)
@@ -118,7 +118,7 @@
  * Initialize KX subsystem.
  *
  * @param pk private key to use for the peer
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
  */
 int
 GSC_KX_init (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);

Modified: gnunet/src/core/gnunet-service-core_neighbours.c
===================================================================
--- gnunet/src/core/gnunet-service-core_neighbours.c    2014-04-07 09:18:17 UTC 
(rev 32901)
+++ gnunet/src/core/gnunet-service-core_neighbours.c    2014-04-07 09:19:28 UTC 
(rev 32902)
@@ -531,8 +531,8 @@
  *
  * @param cls unused
  * @param key peer identity
- * @param value the 'struct Neighbour' to free
- * @return GNUNET_OK (continue to iterate)
+ * @param value the `struct Neighbour` to free
+ * @return #GNUNET_OK (continue to iterate)
  */
 static int
 free_neighbour_helper (void *cls,

Modified: gnunet/src/core/gnunet-service-core_sessions.c
===================================================================
--- gnunet/src/core/gnunet-service-core_sessions.c      2014-04-07 09:18:17 UTC 
(rev 32901)
+++ gnunet/src/core/gnunet-service-core_sessions.c      2014-04-07 09:19:28 UTC 
(rev 32902)
@@ -31,7 +31,9 @@
 #include "gnunet-service-core_sessions.h"
 #include "gnunet-service-core_clients.h"
 #include "gnunet_constants.h"
+#include "core.h"
 
+
 /**
  * How often do we transmit our typemap?
  */
@@ -730,14 +732,13 @@
 
 
 /**
- * Helper function for GSC_SESSIONS_handle_client_iterate_peers.
+ * Helper function for #GSC_SESSIONS_handle_client_iterate_peers().
  *
  * @param cls the `struct GNUNET_SERVER_TransmitContext` to queue replies
  * @param key identity of the connected peer
  * @param value the `struct Neighbour` for the peer
- * @return GNUNET_OK (continue to iterate)
+ * @return #GNUNET_OK (continue to iterate)
  */
-#include "core.h"
 static int
 queue_connect_message (void *cls,
                        const struct GNUNET_PeerIdentity *key,
@@ -769,8 +770,7 @@
 void
 GSC_SESSIONS_handle_client_iterate_peers (void *cls,
                                           struct GNUNET_SERVER_Client *client,
-                                          const struct GNUNET_MessageHeader
-                                          *message)
+                                          const struct GNUNET_MessageHeader 
*message)
 {
   struct GNUNET_MessageHeader done_msg;
   struct GNUNET_SERVER_TransmitContext *tc;

Modified: gnunet/src/include/gnunet_protocols.h
===================================================================
--- gnunet/src/include/gnunet_protocols.h       2014-04-07 09:18:17 UTC (rev 
32901)
+++ gnunet/src/include/gnunet_protocols.h       2014-04-07 09:19:28 UTC (rev 
32902)
@@ -333,7 +333,6 @@
  */
 #define GNUNET_MESSAGE_TYPE_CORE_SEND 76
 
-
 /**
  * Request for peer iteration from CORE service.
  */
@@ -622,7 +621,7 @@
 #define GNUNET_MESSAGE_TYPE_DHT_P2P_VERIFY_SUCCESSOR           159
 
 /**
- * Notify your new immediate successor that you are its new predecessor. 
+ * Notify your new immediate successor that you are its new predecessor.
  */
 #define GNUNET_MESSAGE_TYPE_DHT_P2P_NOTIFY_NEW_SUCCESSOR           160
 
@@ -632,7 +631,7 @@
 #define GNUNET_MESSAGE_TYPE_DHT_P2P_VERIFY_SUCCESSOR_RESULT    161
 
 /**
- * Message which contains the get result. 
+ * Message which contains the get result.
  */
 #define GNUNET_MESSAGE_TYPE_DHT_P2P_GET_RESULT                 162
 
/*******************************************************************************

Modified: gnunet/src/util/os_priority.c
===================================================================
--- gnunet/src/util/os_priority.c       2014-04-07 09:18:17 UTC (rev 32901)
+++ gnunet/src/util/os_priority.c       2014-04-07 09:19:28 UTC (rev 32902)
@@ -1225,8 +1225,6 @@
 }
 
 
-
-
 /**
  * Start a process.
  *
@@ -1234,6 +1232,7 @@
  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
  * @param pipe_stdin pipe to use to send input to child process (or NULL)
  * @param pipe_stdout pipe to use to get output from child process (or NULL)
+ * @param pipe_stderr pipe to use to get output from child process (or NULL)
  * @param filename name of the binary
  * @param argv NULL-terminated array of arguments to the process
  * @return pointer to process structure of the new process, NULL on error
@@ -1265,6 +1264,7 @@
  * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
  * @param pipe_stdin pipe to use to send input to child process (or NULL)
  * @param pipe_stdout pipe to use to get output from child process (or NULL)
+ * @param pipe_stderr pipe to use to get output from child process (or NULL)
  * @param filename name of the binary
  * @param va NULL-terminated list of arguments to the process
  * @return pointer to process structure of the new process, NULL on error