Improve docs

KittehOrg · Jul 10, 2016 · 0320323 · 0320323
1 parent e81a66d
commit 0320323
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 9 deletions.
diff --git a/docs/events.md b/docs/events.md
@@ -45,7 +45,7 @@ Below is an example from the JavaDocs:
 
 ```java
 @CommandFilter("PRIVMSG")
-@Handler(filters = @Filter(CommandFilter.Filter.class))
+@Handler
 public void privmsg(ClientReceiveCommandEvent event) {
     System.out.println("We get signal!");
 }

diff --git a/docs/ircv3.md b/docs/ircv3.md
@@ -8,14 +8,6 @@ CAP | multi-prefix | sasl | account-notify | away-notify | extended-join | tls
 :-: | :----------: | :--: | :------------: | :---------: | :-----------: | :-:
 ✔   | ✔            | ✔    | ✔              | ✔           | ✔             | ✘
 
-##### Notes
-* SASL mechanisms supported and the classes for using them:
-    * PLAIN - `SaslPlain`
-    * [ECDSA-NIST256P-CHALLENGE](advanced/ecdsa.md) - `SaslECDSANIST256PChallenge`
-    * EXTERNAL - `SaslExternal`
-* The TLS extension, which is a STARTTLS approach, will likely never be supported. It is horrible and evil and should be destroyed!
-    * Use the [SSL](advanced/ssl.md) support that KICL has built-in instead.
-
 
 ### IRCv3.2
 
@@ -26,3 +18,16 @@ CAP | Message Tags | Metadata | Monitor | account-tag | batch | cap-notify
 chghost | echo-message | invite-notify | sasl | server-time | userhost-in-names
 :-----: | :----------: | :-----------: | :--: | :---------: | :---------------:
 ✔       | ✔            | ✔             | ✔    | ✔           | ✔
+
+#### Notes
+* The following capabilities are supported in the code are not automatically requested:
+    * SASL
+    * echo-message
+        * After requesting you can also use the annotation filter `@EchoMessage` on events to only receive echoed messages.
+    * invite-notify
+* SASL mechanisms supported and the classes for using them:
+    * PLAIN - `SaslPlain`
+    * [ECDSA-NIST256P-CHALLENGE](advanced/ecdsa.md) - `SaslECDSANIST256PChallenge`
+    * EXTERNAL - `SaslExternal`
+* The TLS extension, which is a STARTTLS approach, will likely never be supported. It is horrible and evil and should be destroyed!
+    * Use the [SSL](advanced/ssl.md) support that KICL has built-in instead.
diff --git a/src/main/java/org/kitteh/irc/client/library/element/mode/ModeStatusList.java b/src/main/java/org/kitteh/irc/client/library/element/mode/ModeStatusList.java
@@ -40,6 +40,8 @@
 
 /**
  * A list of mode statuses.
+ *
+ * @param <ModeType> type of modes being listed
  */
 public class ModeStatusList<ModeType extends Mode> {
     /**
@@ -110,6 +112,7 @@ private static <ModeType extends Mode> ModeStatusList<ModeType> from(@Nonnull Cl
      * Creates a list of the given statuses.
      *
      * @param statuses statuses
+     * @param <ModeType> type of modes being listed
      * @return list
      */
     @Nonnull
@@ -123,6 +126,7 @@ public static <ModeType extends Mode> ModeStatusList<ModeType> of(@Nonnull ModeS
      * Creates a list of the given statuses.
      *
      * @param statuses statuses
+     * @param <ModeType> type of modes being listed
      * @return list
      */
     @Nonnull