- fix/update javadoc on jsonrpc annotation

jknack · jknack · commit 3df4e4e78173 · 2026-03-08T20:59:27.000-03:00
diff --git a/jooby/src/main/java/io/jooby/annotation/JsonRpc.java b/jooby/src/main/java/io/jooby/annotation/JsonRpc.java
@@ -11,27 +11,30 @@
 import java.lang.annotation.Target;
 
 /**
- * Marks a class and its methods as a JSON-RPC 2.0 endpoint. *
+ * Marks a class or its methods as a JSON-RPC 2.0 endpoint.
  *
- * <p>To expose a method via JSON-RPC, the method <b>must</b> be annotated with {@code @JsonRpc}. If
- * a class contains methods annotated with {@code @JsonRpc}, the class itself can optionally be
- * annotated to define a common namespace. *
+ * <h3>Discovery Rules:</h3>
  *
- * <h3>Routing Rules:</h3>
+ * <ul>
+ *   <li><b>Implicit Mapping:</b> If a class is annotated with {@code @JsonRpc} and <b>no</b>
+ *       methods are explicitly annotated, <b>all</b> public methods are automatically exposed as
+ *       JSON-RPC endpoints.
+ *   <li><b>Explicit Mapping:</b> If at least <b>one</b> method in the class is explicitly annotated
+ *       with {@code @JsonRpc}, implicit mapping is disabled. <b>Only</b> the annotated methods will
+ *       be exposed, requiring you to map any other desired endpoints one by one.
+ * </ul>
+ *
+ * <h3>Naming & Routing Rules:</h3>
  *
  * <ul>
  *   <li><b>Class Level (Namespace):</b> When applied to a class, the {@link #value()} defines the
  *       namespace for all JSON-RPC methods within that class. If the annotation is present but the
- *       value is empty, the simple class name (e.g., {@code MovieService}) is used as the
- *       namespace. If the class is not annotated at all, the methods are registered without a
- *       namespace. *
- *   <li><b>Method Level (Method Name):</b> When applied to a method, the method is exposed over
- *       JSON-RPC. The {@link #value()} defines the exact RPC method name. If the value is empty,
- *       the actual Java/Kotlin method name is used.
+ *       value is empty (the default), <b>no namespace</b> is applied.
+ *   <li><b>Method Level (Method Name):</b> When applied to a method, the {@link #value()} defines
+ *       the exact RPC method name. If the value is empty, the actual Java/Kotlin method name is
+ *       used.
  * </ul>
  *
- * *
- *
  * <p>The final JSON-RPC method string expected by the dispatcher is formatted as {@code
  * "namespace.methodName"} (or just {@code "methodName"} if no namespace exists).
  */
@@ -41,8 +44,8 @@
 
   /**
    * The explicit namespace (when used on a class) or the explicit method name (when used on a
-   * method). * @return The overridden name, or an empty string to use the defaults (Simple Class
-   * Name or Method Name).
+   * method). * @return The overridden name, or an empty string to use the defaults (no namespace
+   * for classes, actual method name for methods).
    */
   String value() default "";
 }
