From: David ‘Bombe’ Roden <bombe@freenetproject.org>
Date: Tue, 3 Sep 2024 09:43:44 +0000 (+0200)
Subject: 📝 Slightly improve javadoc
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=74daadf9ef5898b9dff6775b594919db77540fa7;p=jFCPlib.git

📝 Slightly improve javadoc
---

diff --git a/src/main/java/net/pterodactylus/fcp/SentFeed.java b/src/main/java/net/pterodactylus/fcp/SentFeed.java
index 4256293..fbe9f1b 100644
--- a/src/main/java/net/pterodactylus/fcp/SentFeed.java
+++ b/src/main/java/net/pterodactylus/fcp/SentFeed.java
@@ -49,7 +49,7 @@ public class SentFeed extends BaseMessage implements Identifiable {
 	/**
 	 * Returns the node status of the peer. The node status is definied in
 	 * {@code freenet.node.PeerManager}.
-	 * <p>
+	 *
 	 * <ol start="1">
 	 * <li>Connected</li>
 	 * <li>Backed off</li>
diff --git a/src/main/java/net/pterodactylus/fcp/package-info.java b/src/main/java/net/pterodactylus/fcp/package-info.java
index 04b0cc6..9b9b0b5 100644
--- a/src/main/java/net/pterodactylus/fcp/package-info.java
+++ b/src/main/java/net/pterodactylus/fcp/package-info.java
@@ -3,20 +3,24 @@
  * with a Freenet Node.
  *
  * <h2>Usage</h2>
- *
+ * <p>
  * 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.
- *
+ * </p>
+ * <p>
  * First, create a connection to the node:
- *
+ *</p>
  * <pre>
- * FcpConnection fcpConnection = new FcpConnection();
+ * FcpConnection fcpConnection = new DefaultFcpConnection();
  * </pre>
  *
  * Now implement the {@link net.pterodactylus.fcp.FcpListener} interface
+ * or extend {@link net.pterodactylus.fcp.FcpAdapter} to create a listener
+ * to {@link net.pterodactylus.fcp.FcpConnection#addFcpListener(net.pterodactylus.fcp.FcpListener) register}
+ * with the FCP connection, call {@link net.pterodactylus.fcp.FcpConnection#connect()},
  * and handle all incoming events.
  *
  * <pre>
@@ -33,4 +37,3 @@
  */
 
 package net.pterodactylus.fcp;
-