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

[gnunet]

Author: dold
Date: 2013-11-04 00:25:33 +0100 (Mon, 04 Nov 2013)
New Revision: 30498

Modified:
   gnunet/src/include/gnunet_secretsharing_service.h
Log:
clarifications

Modified: gnunet/src/include/gnunet_secretsharing_service.h
===================================================================
--- gnunet/src/include/gnunet_secretsharing_service.h   2013-11-03 23:21:13 UTC 
(rev 30497)
+++ gnunet/src/include/gnunet_secretsharing_service.h   2013-11-03 23:25:33 UTC 
(rev 30498)
@@ -97,8 +97,12 @@
 
 
 /**
- * Called once the secret has been established.
+ * Called once the secret has been established with all peers, or the deadline 
is due.
  *
+ * Note that the number of peers can be smaller that 'k' (this threshold 
parameter), which
+ * makes the threshold crypto system useledd.  However, in this case one can 
still determine which peers
+ * were able to participate in the secret sharing successfully.
+ *
  * @param cls closure
  * @param public_key public key of the session
  * @param num_ready_peers number of peers in @ready_peers
@@ -186,6 +190,8 @@
  *
  * The decrypt_cb is not called anymore, but the calling
  * peer may already have irrevocably contributed his share for the decryption 
of the value.
+ *
+ * @param decryption_handle decryption to cancel
  */
 void
 GNUNET_SECRETSHARING_cancel_decrypt (struct 
GNUNET_SECRETSHARING_DecryptionHandle *decryption_handle);