add PersistentRequestModified

[jSite2.git] / src / net / pterodactylus / util / fcp / package-info.java

diff --git a/src/net/pterodactylus/util/fcp/package-info.java b/src/net/pterodactylus/util/fcp/package-info.java
index 0567b50..82971fc 100644 (file)
--- a/src/net/pterodactylus/util/fcp/package-info.java
+++ b/src/net/pterodactylus/util/fcp/package-info.java
@@ -1,4 +1,47 @@
 /**
- * Package that holds all the message types that are used in the communication with a Freenet Node.
+ * Package that holds all the message types that are used in the communication
+ * with a Freenet Node.
+ * 
+ * <h2>Usage</h2>
+ * 
+ * This library was designed to implement the full range of the Freenet Client
+ * Protocol, Version 2.0. At the moment the library provides a rather low-level
+ * approach, wrapping each FCP message into its own object but some kind of
+ * high-level client that does not require any interfaces to be implemented
+ * will probably provided as well.
+ * 
+ * So far there are three kinds of approach on using the FCP library in your
+ * own projects: the {@link net.pterodactylus.util.fcp.FcpListener} method, the
+ * {@link net.pterodactylus.util.fcp.FcpAdapter} method, and the
+ * {@link net.pterodactylus.util.fcp.FcpHighLevelClient} method (<em>not yet
+ * implemented</em>).
+ * 
+ * For all three methods you need an instance of
+ * {@link net.pterodactylus.util.fcp.FcpConnection}. Create this to connect to
+ * your Freenet node.
+ * 
+ * <pre>
+ * FcpConnection fcpConnection = new FcpConnection();
+ * </pre>
+ * 
+ * <h3>The FcpListener Method</h3>
+ * 
+ * Implement the {@link net.pterodactylus.util.fcp.FcpListener} interface and
+ * handle every incoming event.
+ * 
+ * <pre>
+ * public class MyClass implements FcpListener {
+ * 
+ *     public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
+ *             …
+ *     }
+ * 
+ *     // implement all further methods here
+ * 
+ * }
+ * </pre>
+ * 
+ * Next, create
  */
-package net.pterodactylus.util.fcp;
\ No newline at end of file
+package net.pterodactylus.util.fcp;
+