fixed doxygen

1 files changed, 19 insertions, 10 deletions

diff --git a/src/include/gnunet_consensus_service.h b/src/include/gnunet_consensus_service.h
index 8e2d8f572..bd7e83fe1 100644
--- a/src/include/gnunet_consensus_service.h
+++ b/src/include/gnunet_consensus_service.h
@@ -85,6 +85,8 @@ struct GNUNET_CONSENSUS_Handle;
 
 /**
  * Create a consensus session.
+ * The set being reconciled is initially empty.  Only reconcile with other peers
+ * after GNUNET_CONSENSUS_reconcile has been called.
  *
  * @param cfg
  * @param num_peers
@@ -92,9 +94,7 @@ struct GNUNET_CONSENSUS_Handle;
  *              Inclusion of the local peer is optional.
  * @param session_id session identifier
  *                   Allows a group of peers to have more than consensus session.
- * @param num_initial_elements number of entries in the 'initial_elements' array
- * @param initial_elements our elements for the consensus (each of 'element_size'
- * @param new_element callback, called when a new element is added to the set by
+ * @param new_element_cb callback, called when a new element is added to the set by
  *                    another peer
  * @param new_element_cls closure for new_element
  * @return handle to use, NULL on error
@@ -104,11 +104,7 @@ GNUNET_CONSENSUS_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
                          unsigned int num_peers,
                          const struct GNUNET_PeerIdentity *peers,
                          const struct GNUNET_HashCode *session_id,
-                         /*
-                         unsigned int num_initial_elements,
-                         const struct GNUNET_CONSENSUS_Element **initial_elements,
-                         */
-                         GNUNET_CONSENSUS_NewElementCallback new_element,
+                         GNUNET_CONSENSUS_NewElementCallback new_element_cb,
                          void *new_element_cls);
 
 
@@ -126,8 +122,9 @@ typedef void (*GNUNET_CONSENSUS_InsertDoneCallback) (void *cls,
 
 
 /**
- * Insert an element in the set being reconsiled.  Must not be called after
- * "GNUNET_CONSENSUS_conclude".
+ * Insert an element in the set being reconsiled.  Only transmit changes to
+ * other peers if "GNUNET_CONSENSUS_begin" has been called.
+ * Must not be called after "GNUNET_CONSENSUS_conclude".
  *
  * @param consensus handle for the consensus session
  * @param element the element to be inserted
@@ -143,6 +140,18 @@ GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus,
 
 
 /**
+ * Begin reconciling elements with other peers.
+ * May not be called if an insert operation has not yet finished.
+ *
+ * @param consensus handle for the consensus session
+ */
+void
+GNUNET_CONSENSUS_begin (struct GNUNET_CONSENSUS_Handle *consensus);
+
+
+
+
+/**
  * Called when a conclusion was successful.
  *
  * @param cls