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

[gnunet]

Author: tg
Date: 2013-07-16 10:42:14 +0200 (Tue, 16 Jul 2013)
New Revision: 28080

Modified:
   gnunet/src/include/gnunet_psyc_service.h
   gnunet/src/include/gnunet_psycstore_service.h
   gnunet/src/include/gnunet_social_service.h
Log:
psyc/social docs

Modified: gnunet/src/include/gnunet_psyc_service.h
===================================================================
--- gnunet/src/include/gnunet_psyc_service.h    2013-07-16 08:40:53 UTC (rev 
28079)
+++ gnunet/src/include/gnunet_psyc_service.h    2013-07-16 08:42:14 UTC (rev 
28080)
@@ -226,7 +226,7 @@
  * @param is_admitted #GNUNET_YES if joining is approved,
  *        #GNUNET_NO if it is disapproved
  * @param method_name Method name for the message transmitted with the 
response.
- * @param env Environment: transient variables for the message.
+ * @param env Environment containing transient variables for the message, or 
NULL.
  * @param data_size Size of @a data.
  * @param data Data of the message.
  */
@@ -330,7 +330,8 @@
  * @param increment_group_generation #GNUNET_YES if we need to increment
  *        the group generation counter after transmitting this message.
  * @param method_name Which method should be invoked.
- * @param env Environment: state operations and transient variables for the 
message.
+ * @param env Environment containing state operations and transient variables
+ *            for the message, or NULL.
  * @param notify Function to call to obtain the arguments.
  * @param notify_cls Closure for @a notify.
  * @return Transmission handle, NULL on error (i.e. more than one request 
queued).
@@ -438,7 +439,7 @@
  *
  * @param slave Slave handle.
  * @param method_name Which (PSYC) method should be invoked (on host).
- * @param env Environment: transient variables for the message.
+ * @param env Environment containing transient variables for the message, or 
NULL.
  * @param notify Function to call when we are allowed to transmit (to get 
data).
  * @param notify_cls Closure for @a notify.
  * @return Transmission handle, NULL on error (i.e. more than one request 
queued).

Modified: gnunet/src/include/gnunet_psycstore_service.h
===================================================================
--- gnunet/src/include/gnunet_psycstore_service.h       2013-07-16 08:40:53 UTC 
(rev 28079)
+++ gnunet/src/include/gnunet_psycstore_service.h       2013-07-16 08:42:14 UTC 
(rev 28080)
@@ -179,7 +179,7 @@
 struct GNUNET_PSYCSTORE_OperationHandle *
 GNUNET_PSYCSTORE_fragment_get (struct GNUNET_PSYCSTORE_Handle *h,
                                const struct GNUNET_HashCode *channel_id,
-                               uint64_t message_id,
+                               uint64_t fragment_id,
                                GNUNET_PSYCSTORE_FragmentResultCallback rcb,
                                void *rcb_cls);
 

Modified: gnunet/src/include/gnunet_social_service.h
===================================================================
--- gnunet/src/include/gnunet_social_service.h  2013-07-16 08:40:53 UTC (rev 
28079)
+++ gnunet/src/include/gnunet_social_service.h  2013-07-16 08:42:14 UTC (rev 
28080)
@@ -337,6 +337,7 @@
  *
  * @param home Home to address the announcement to.
  * @param method_name Method to use for the announcement.
+ * @param env Environment containing variables for the message, or NULL.
  * @param notify Function to call to get the payload of the announcement.
  * @param notify_cls Closure for @a notify.
  * @return NULL on error (announcement already in progress?).
@@ -394,12 +395,11 @@
  *
  * @param cfg Configuration to contact the social service.
  * @param ego Owner of the home (host).
- * @param address Address of the place to enter (GADS name, i.e. 
'room.friend.gads'),
- *        if the name has the form 'HEX.place', GADS is not
- *        used and HEX is assumed to be the hash of the public
- *        key already; 'HEX.zkey' however would refer to
- *        the 'PLACE' record in the GADS zone with the public key
- *        'HEX'.
+ * @param address GADS name of the place to enter.  Either in the form of
+ *        'room.friend.gads', or 'HEX.zkey'.  This latter case refers to the
+ *        'PLACE' record in the GADS zone with the public key 'HEX', and can be
+ *        used to request entry to a pseudonym's place directly.
+ * @param env Environment containing variables for the message, or NULL.
  * @param msg_size Number of bytes in @a msg.
  * @param msg Message to give to the enter callback.
  * @param slicer Slicer to use for processing incoming requests from guests.
@@ -422,6 +422,7 @@
  * @param crypto_address Public key of the place to enter.
  * @param peer Peer to send request to.
  * @param slicer Slicer to use for processing incoming requests from guests.
+ * @param env Environment containing variables for the message, or NULL.
  * @param msg_size Number of bytes in @a msg.
  * @param msg Message to give to the enter callback.
  * @return NULL on errors, otherwise handle to the place.
@@ -533,6 +534,7 @@
  *
  * @param place Place where we want to talk to the host.
  * @param method_name Method to invoke on the host.
+ * @param env Environment containing variables for the message, or NULL.
  * @param notify Function to use to get the payload for the method.
  * @param notify_cls Closure for @a notify.
  * @return NULL if we are already trying to talk to the host,