From 74daadf9ef5898b9dff6775b594919db77540fa7 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Tue, 3 Sep 2024 11:43:44 +0200 Subject: [PATCH] =?utf8?q?=F0=9F=93=9D=20Slightly=20improve=20javadoc?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- src/main/java/net/pterodactylus/fcp/SentFeed.java | 2 +- src/main/java/net/pterodactylus/fcp/package-info.java | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) 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}. - *

+ * *

    *
  1. Connected
  2. *
  3. Backed off
  4. 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. * *

    Usage

    - * + *

    * 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. - * + *

    + *

    * First, create a connection to the node: - * + *

    *
    - * FcpConnection fcpConnection = new FcpConnection();
    + * FcpConnection fcpConnection = new DefaultFcpConnection();
      * 
    * * 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. * *
    @@ -33,4 +37,3 @@
      */
     
     package net.pterodactylus.fcp;
    -
    -- 
    2.7.4