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

[gnunet]

Author: tg
Date: 2013-07-15 09:54:16 +0200 (Mon, 15 Jul 2013)
New Revision: 28033

Modified:
   gnunet/src/include/gnunet_env_lib.h
   gnunet/src/include/gnunet_multicast_service.h
   gnunet/src/include/gnunet_psyc_service.h
   gnunet/src/include/gnunet_psycstore_service.h
   gnunet/src/include/gnunet_social_service.h
Log:
env: doc; spaces

Modified: gnunet/src/include/gnunet_env_lib.h
===================================================================
--- gnunet/src/include/gnunet_env_lib.h 2013-07-15 07:25:15 UTC (rev 28032)
+++ gnunet/src/include/gnunet_env_lib.h 2013-07-15 07:54:16 UTC (rev 28033)
@@ -30,34 +30,34 @@
  * Possible operations on PSYC state (persistent) and transient variables (per 
message).
  */
 enum GNUNET_ENV_Operator
-{ 
-  /**
+{
+  /** 
    * Set value of a transient variable.
    */
   GNUNET_ENV_OP_SET = ':',
 
-  /**
+  /** 
    * Assign value for a persistent state variable.
    *
    * If an assigned value is NULL, the variable is deleted.
    */
   GNUNET_ENV_OP_ASSIGN = '=',
 
-  /**
+  /** 
    * Augment state variable.
    *
    * Used for appending strings, adding numbers, and adding new items to a 
list or dictionary.
    */
   GNUNET_ENV_OP_AUGMENT = '+',
 
-  /**
+  /** 
    * Diminish state variable.
    *
    * Used for subtracting numbers, and removing items from a list or 
dictionary.
    */
   GNUNET_ENV_OP_DIMINISH = '-',
 
-  /**
+  /** 
    * Update state variable.
    *
    * Used for modifying a single item of a list or dictionary.
@@ -66,7 +66,7 @@
 };
 
 
-/**
+/** 
  * PSYC variable types.
  */
 enum GNUNET_ENV_Type
@@ -78,33 +78,33 @@
 };
 
 
-/**
+/** 
  * PSYC state modifier.
  */
 struct GNUNET_ENV_Modifier {
-  /**
+  /** 
    * State operation.
    */
   GNUNET_ENV_Operator oper;
 
-  /**
+  /** 
    * Variable name.
    */
   const char *name;
 
-  /**
+  /** 
    * Size of @a value.
    */
   size_t value_size;
 
-  /**
+  /** 
    * Value of variable.
    */
   const void *value;
 };
 
 
-/**
+/** 
  * Environment for a message.
  *
  * Contains modifiers.
@@ -159,7 +159,7 @@
  * @param modifiers_length Number of @a modifiers.
  * @param modifiers Array of modifiers to add.
  * 
- * @return 
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error.
  */
 int
 GNUNET_ENV_environment_set_modifiers (const struct GNUNET_ENV_Environment *env,
@@ -192,7 +192,7 @@
  *
  * @param size Size of value.
  * @param value Raw value of variable.
- * @param[out] number Value converted to a 64-bit integer. 
+ * @param[out] number Value converted to a 64-bit integer.
  *
  * @return #GNUNET_OK on success, #GNUNET_SYSERR if an error occurred (e.g. 
the value is invalid).
  */

Modified: gnunet/src/include/gnunet_multicast_service.h
===================================================================
--- gnunet/src/include/gnunet_multicast_service.h       2013-07-15 07:25:15 UTC 
(rev 28032)
+++ gnunet/src/include/gnunet_multicast_service.h       2013-07-15 07:54:16 UTC 
(rev 28033)
@@ -60,7 +60,7 @@
  */
 enum GNUNET_MULTICAST_JoinPolicy
 {
-  /** 
+  /**
    * Anyone can join the group, without announcing his presence;
    * all messages are always public and can be distributed freely.
    * Joins may be announced, but this is not required.
@@ -447,12 +447,12 @@
 
   /** 
    * Everything is fine.
-   */ 
+   */
   GNUNET_MULTICAST_REC_OK = 0,
 
   /** 
    * Message fragment has been discarded (likely transient message that was 
too old).
-   */ 
+   */
   GNUNET_MULTICAST_REC_TRANSIENT_LOST = 1,
 
   /** 
@@ -460,12 +460,12 @@
    * replay function has ever encountered; thus it is likely the
    * origin never sent it and we're at the HEAD of the multicast
    * stream as far as this node is concerned.
-   */ 
+   */
   GNUNET_MULTICAST_REC_PAST_HEAD = 2,
 
   /** 
    * Internal error (i.e. database error).  Try some other peer.
-   */ 
+   */
   GNUNET_MULTICAST_REC_INTERNAL_ERROR = 3
 
 };
@@ -511,7 +511,7 @@
  * @return Handle for the origin, NULL on error.
  */
 struct GNUNET_MULTICAST_Origin *
-GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg, 
+GNUNET_MULTICAST_origin_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
                               void *cls,
                               const struct GNUNET_CRYPTO_EccPrivateKey 
*priv_key,
                               enum GNUNET_MULTICAST_JoinPolicy join_policy,
@@ -591,18 +591,18 @@
  *        this peer already knows from this group; NULL if this
  *        client is unable to support replay.
  * @param test_cb Function multicast can use to test group membership.
- * @param message_cb Function to be called for all message fragments we 
+ * @param message_cb Function to be called for all message fragments we
  *        receive from the group, excluding those our @a replay_cb
  *        already has.
  * @param cls Closure for callbacks.
  * @param join_req Application-dependent join message to be passed to origin
- *        (might, for example, contain a user 
+ *        (might, for example, contain a user
  *        bind user identity/pseudonym to peer identity, application-level
  *        message to origin, etc.).
  * @return Handle for the member, NULL on error.
  */
 struct GNUNET_MULTICAST_Member *
-GNUNET_MULTICAST_member_join (const struct GNUNET_CONFIGURATION_Handle *cfg, 
+GNUNET_MULTICAST_member_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
                              const struct GNUNET_CRYPTO_EccPublicKey *pub_key,
                               const struct GNUNET_PeerIdentity *origin,
                              uint64_t max_known_fragment_id,
@@ -664,7 +664,7 @@
 
 
 /** 
- * Send a message to the origin of the multicast group.  
+ * Send a message to the origin of the multicast group.
  * 
  * @param member Membership handle.
  * @param size Number of bytes we want to send to origin.

Modified: gnunet/src/include/gnunet_psyc_service.h
===================================================================
--- gnunet/src/include/gnunet_psyc_service.h    2013-07-15 07:25:15 UTC (rev 
28032)
+++ gnunet/src/include/gnunet_psyc_service.h    2013-07-15 07:54:16 UTC (rev 
28033)
@@ -33,21 +33,21 @@
  * NOTE:
  * - this API does not know about psyc's "root" and "places";
  *   there is no 'root' in GNUnet-Psyc as we're decentralized;
- *   'places' and 'persons' are combined within the same 
+ *   'places' and 'persons' are combined within the same
  *   abstraction, that of a "channel".  Channels are identified
- *   and accessed in this API using a public/private key.  
+ *   and accessed in this API using a public/private key.
  *   Higher-level applications should use NAMES within GADS
- *   to obtain public keys, and the distinction between 
+ *   to obtain public keys, and the distinction between
  *   'places' and 'persons' can then be made with the help
  *   of the naming system (and/or conventions).
  *   Channels are (as in PSYC) organized into a hierarchy; each
  *   channel master (the one with the private key) is then
- *   the operator of the multicast group (its Origin in 
+ *   the operator of the multicast group (its Origin in
  *   the terminology of the multicast API).
  * - The API supports passing large amounts of data using
  *   'streaming' for the argument passed to a method.  State
  *   and variables must fit into memory and cannot be streamed
- *   (thus, no passing of 4 GB of data in a variable; 
+ *   (thus, no passing of 4 GB of data in a variable;
  *   once we implement this, we might want to create a
  *   @c \#define for the maximum size of a variable).
  * - PSYC defines standard variables, methods, etc.  This
@@ -65,7 +65,7 @@
  *   receives messages (but never forwards; private responses
  *   would be transmitted by joining the senders 'inbox'
  *   channel -- or a inbox#bob subchannel).  The
- *   goal for all of this is to keep the abstractions in this 
+ *   goal for all of this is to keep the abstractions in this
  *   API minimal: interaction with multicast, try \& slice,
  *   state/variable/channel management.  Higher-level
  *   operations belong elsewhere (so maybe this API should
@@ -134,7 +134,7 @@
 
 /** 
  * Method called from PSYC upon receiving a message indicating a call
- * to a @e method.  
+ * to a @e method.
  *
  * @param cls Closure.
  * @param sender Who transmitted the message (master, except for messages
@@ -149,7 +149,7 @@
  * @param header Modifiers present in the message. FIXME: use environment 
instead?
  * @param data_offset Byte offset of @a data in the overall data of the method.
  * @param data_size Number of bytes in @a data.
- * @param data Data stream given to the method (might not be zero-terminated 
+ * @param data Data stream given to the method (might not be zero-terminated
  *             if data is binary).
  * @param frag Fragmentation status for the data.
  */
@@ -174,7 +174,7 @@
  * @param header_length Number of modifiers in header.
  * @param header Modifiers present in the message.
  * @param data_size Number of bytes in @a data.
- * @param data Data stream given to the method (might not be zero-terminated 
+ * @param data Data stream given to the method (might not be zero-terminated
  *             if data is binary).
  */
 typedef int (*GNUNET_PSYC_JoinCallback)(void *cls,
@@ -196,7 +196,7 @@
  * @param header_length Number of modifiers in header.
  * @param header Modifiers present in the message.
  * @param data_size Number of bytes in @a data.
- * @param data Data stream given to the method (might not be zero-terminated 
+ * @param data Data stream given to the method (might not be zero-terminated
  *             if data is binary).
  */
 typedef int (*GNUNET_PSYC_PartCallback)(void *cls,
@@ -300,7 +300,7 @@
  * @param[out] data Where to write the body of the message to give to the 
method;
  *        function must copy at most @a *data_size bytes to @a data.
  * @return #GNUNET_SYSERR on error (fatal, aborts transmission)
- *         #GNUNET_NO on success, if more data is to be transmitted later 
+ *         #GNUNET_NO on success, if more data is to be transmitted later
  *         (should be used if @a *data_size was not big enough to take all the 
data)
  *         #GNUNET_YES if this completes the transmission (all data supplied)
  */
@@ -311,7 +311,7 @@
 
 
 /** 
- * Handle for a pending PSYC transmission operation. 
+ * Handle for a pending PSYC transmission operation.
  */
 struct GNUNET_PSYC_MasterTransmitHandle;
 
@@ -363,20 +363,20 @@
 
 /** 
  * Convert a channel @a master to a @e channel handle to access the @e channel 
APIs.
- * 
+ *
  * @param master Channel master handle.
  * @return Channel handle, valid for as long as @a master is valid.
- */ 
+ */
 struct GNUNET_PSYC_Channel *
 GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
 
 
 /** 
  * Convert @a slave to a @e channel handle to access the @e channel APIs.
- * 
+ *
  * @param slave Slave handle.
  * @return Channel handle, valid for as long as @a slave is valid.
- */ 
+ */
 struct GNUNET_PSYC_Channel *
 GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
 
@@ -473,7 +473,7 @@
  * @return Handle for the slave, NULL on error.
  */
 struct GNUNET_PSYC_Slave *
-GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg, 
+GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
                         const struct GNUNET_CRYPTO_EccPublicKey *pub_key,
                         const struct GNUNET_PeerIdentity *origin,
                         GNUNET_PSYC_Method method,
@@ -565,9 +565,9 @@
  * @param end_message_id Last (exclusive) interesting point in history.
  * @param method Function to invoke on messages received from the story.
  * @param method_cls Closure for @a method.
- * @param finish_cb Function to call when the requested story has been fully 
+ * @param finish_cb Function to call when the requested story has been fully
  *        told (counting message IDs might not suffice, as some messages
- *        might be secret and thus the listener would not know the story is 
+ *        might be secret and thus the listener would not know the story is
  *        finished without being told explicitly); once this function
  *        has been called, the client must not call
  *        GNUNET_PSYC_slave_story_tell_cancel() anymore.
@@ -609,7 +609,7 @@
  * values stored under "_a_b_c".
  *
  * @param slave Slave handle.
- * @param state_name Name of the state to query (full name 
+ * @param state_name Name of the state to query (full name
  *        might be longer, this is only the prefix that must match).
  * @param cb Function to call on the matching state values.
  * @param cb_cls Closure for @a cb.
@@ -636,7 +636,7 @@
  *
  * @param slave Slave handle.
  * @param variable_name Name of the variable to query.
- * @param[out] return_value_size Set to number of bytes in variable, 
+ * @param[out] return_value_size Set to number of bytes in variable,
  *        needed as variables might contain binary data and
  *        might also not be 0-terminated; set to 0 on errors.
  * @return NULL on error (no matching state or variable), pointer

Modified: gnunet/src/include/gnunet_psycstore_service.h
===================================================================
--- gnunet/src/include/gnunet_psycstore_service.h       2013-07-15 07:25:15 UTC 
(rev 28032)
+++ gnunet/src/include/gnunet_psycstore_service.h       2013-07-15 07:54:16 UTC 
(rev 28033)
@@ -160,7 +160,7 @@
  * @param message The retrieved message fragment.
  * @param flags Message flags indicating fragmentation status.
  */
-typedef void (*GNUNET_PSYCSTORE_FragmentResultCallback)(void *cls,     
+typedef void (*GNUNET_PSYCSTORE_FragmentResultCallback)(void *cls,
                                                       const struct 
GNUNET_MULTICAST_MessageHeader *message,
                                                        enum 
GNUNET_PSYC_MessageFlags flags);
 

Modified: gnunet/src/include/gnunet_social_service.h
===================================================================
--- gnunet/src/include/gnunet_social_service.h  2013-07-15 07:25:15 UTC (rev 
28032)
+++ gnunet/src/include/gnunet_social_service.h  2013-07-15 07:54:16 UTC (rev 
28033)
@@ -88,7 +88,7 @@
  * @param header Modifiers present in the message. FIXME: use environment 
instead?
  * @param data_offset Byte offset of @a data in the overall data of the method.
  * @param data_size Number of bytes in @a data.
- * @param data Data stream given to the method (might not be zero-terminated 
+ * @param data Data stream given to the method (might not be zero-terminated
  *             if data is binary).
  * @param flags Message flags indicating fragmentation status.
  */
@@ -486,7 +486,7 @@
  * Look at matching objects in the place.
  *
  * @param place The place to look its objects at.
- * @param object_filter Only look at objects with names beginning with this 
filter value. 
+ * @param object_filter Only look at objects with names beginning with this 
filter value.
  * @param state_cb Function to call for each object found.
  * @param state_cb_cls Closure for callback function.
  * 
@@ -593,7 +593,7 @@
 void
 GNUNET_SOCIAL_place_get_history_cancel (struct GNUNET_SOCIAL_HistoryLesson 
*hist);
 
-         
+
 /** 
  * Leave a place permanently.
  *