docs / fixed fixme in crypto

1 files changed, 37 insertions, 3 deletions

diff --git a/src/main/java/org/gnunet/core/Core.java b/src/main/java/org/gnunet/core/Core.java
index a4adb32..83e712b 100644
--- a/src/main/java/org/gnunet/core/Core.java
+++ b/src/main/java/org/gnunet/core/Core.java
@@ -23,6 +23,7 @@ package org.gnunet.core;
 import com.google.common.collect.Maps;
 import org.gnunet.construct.Construct;
 import org.gnunet.construct.MessageLoader;
+import org.gnunet.core.messages.*;
 import org.gnunet.mq.Envelope;
 import org.gnunet.requests.MatchingRequestContainer;
 import org.gnunet.requests.Request;
@@ -36,7 +37,7 @@ import java.util.HashMap;
 
 
 /**
- * API for the gnunet core service.
+ * API for the GNUnet core service.
  * <p/>
  * Sends messages to connected peers.
  */
@@ -246,6 +247,11 @@ public class Core {
         }
     }
 
+    /**
+     * Establish a connection to the core service.
+     *
+     * @param cfg configuration to use
+     */
     public Core(Configuration cfg) {
         client = new Client("core", cfg);
         client.installReceiver(new CoreReceiver());
@@ -301,8 +307,8 @@ public class Core {
      * Helper function to retrieve the peer identity with the given configuration via CORE.
      * Should <b>not</b> be used unless there is no other means to obtain the peer identity.
      *
-     * @param cfg
-     * @param cont
+     * @param cfg configuration to use
+     * @param cont continuation, called with the peer identity once available
      */
     public static void withPeerIdentity(Configuration cfg, final PeerIdentityContinuation cont) {
         final Core core = new Core(cfg);
@@ -317,28 +323,54 @@ public class Core {
 
     /**
      * Observe outgoing message headers from core.
+     *
      * @param h callback
      */
     public void observeOutboundHeaders(HeaderNotify h) {
         this.notifyOutboundHeaders = h;
     }
 
+    /**
+     * Observe inbound headers from core.
+     *
+     * @param h callback
+     */
     public void observeInboundHeaders(HeaderNotify h) {
         this.notifyInboundHeaders = h;
     }
 
+    /**
+     * Observe inbound messages from core.
+     *
+     * @param h callback
+     */
     public void observeInboundMessages(MessageNotify h) {
         this.notifyInboundMessages = h;
     }
 
+    /**
+     * Observe outbound messages from core.
+     *
+     * @param h callback
+     */
     public void observeOutboundMessages(MessageNotify h) {
         this.notifyOutboundMessages = h;
     }
 
+    /**
+     * Observe core connections
+     *
+     * @param connectHandler callback
+     */
     public void observeConnect(ConnectHandler connectHandler) {
         this.connectHandler = connectHandler;
     }
 
+    /**
+     * Observe core disconnections.
+     *
+     * @param disconnectHandler callback
+     */
     public void observeDisconnect(DisconnectHandler disconnectHandler) {
         this.disconnectHandler = disconnectHandler;
     }
@@ -347,6 +379,8 @@ public class Core {
      * Handle all incoming messages with the specified runabout.
      * Has to be called before init, as the service has to know which messages we
      * are interested in.
+     *
+     * @param runabout the runabout that will handle received messages
      */
     public void setMessageHandler(Runabout runabout) {
         if (messageHandler != null) {