Clarifies documentation around configKey (OpenFeign#437)

adriancole · web-flow · commit bb0f2924fe5d · 2016-08-14T08:27:57.000+08:00
This adds more javadoc around configKey, including examples of how it is used. See OpenFeign#434
diff --git a/core/src/main/java/feign/Feign.java b/core/src/main/java/feign/Feign.java
@@ -40,17 +40,28 @@ public static Builder builder() {
   }
 
   /**
-   * <br> Configuration keys are formatted as unresolved <a href= "http://docs.oracle.com/javase/6/docs/jdk/api/javadoc/doclet/com/sun/javadoc/SeeTag.html"
-   * >see tags</a>. <br> For example. <ul> <li>{@code Route53}: would match a class such as {@code
-   * denominator.route53.Route53} <li>{@code Route53#list()}: would match a method such as {@code
-   * denominator.route53.Route53#list()} <li>{@code Route53#listAt(Marker)}: would match a method
-   * such as {@code denominator.route53.Route53#listAt(denominator.route53.Marker)} <li>{@code
-   * Route53#listByNameAndType(String, String)}: would match a method such as {@code
-   * denominator.route53.Route53#listAt(String, String)} </ul> <br> Note that there is no whitespace
-   * expected in a key!
+   * Configuration keys are formatted as unresolved <a href= "http://docs.oracle.com/javase/6/docs/jdk/api/javadoc/doclet/com/sun/javadoc/SeeTag.html"
+   * >see tags</a>. This method exposes that format, in case you need to create the same value as
+   * {@link MethodMetadata#configKey()} for correlation purposes.
+   *
+   * <p>Here are some sample encodings:
+   *
+   * <pre>
+   * <ul>
+   *   <li>{@code Route53}: would match a class {@code route53.Route53}</li>
+   *   <li>{@code Route53#list()}: would match a method {@code route53.Route53#list()}</li>
+   *   <li>{@code Route53#listAt(Marker)}: would match a method {@code
+   * route53.Route53#listAt(Marker)}</li>
+   *   <li>{@code Route53#listByNameAndType(String, String)}: would match a method {@code
+   * route53.Route53#listAt(String, String)}</li>
+   * </ul>
+   * </pre>
+   *
+   * Note that there is no whitespace expected in a key!
    *
    * @param targetType {@link feign.Target#type() type} of the Feign interface.
    * @param method invoked method, present on {@code type} or its super.
+   * @see MethodMetadata#configKey()
    */
   public static String configKey(Class targetType, Method method) {
     StringBuilder builder = new StringBuilder();
@@ -136,9 +147,9 @@ public Builder decoder(Decoder decoder) {
      * This flag indicates that the {@link #decoder(Decoder) decoder} should process responses with
      * 404 status, specifically returning null or empty instead of throwing {@link FeignException}.
      *
-     * <p/> All first-party (ex gson) decoders return well-known empty values defined by
-     * {@link Util#emptyValueOf}. To customize further, wrap an existing
-     * {@link #decoder(Decoder) decoder} or make your own.
+     * <p/> All first-party (ex gson) decoders return well-known empty values defined by {@link
+     * Util#emptyValueOf}. To customize further, wrap an existing {@link #decoder(Decoder) decoder}
+     * or make your own.
      *
      * <p/> This flag only works with 404, as opposed to all or arbitrary status codes. This was an
      * explicit decision: 404 -> empty is safe, common and doesn't complicate redirection, retry or
diff --git a/core/src/main/java/feign/MethodMetadata.java b/core/src/main/java/feign/MethodMetadata.java
@@ -48,6 +48,9 @@ public final class MethodMetadata implements Serializable {
   }
 
   /**
+   * Used as a reference to this method. For example, {@link Logger#log(String, String, Object...)
+   * logging} or {@link ReflectiveFeign reflective dispatch}.
+   *
    * @see Feign#configKey(Class, java.lang.reflect.Method)
    */
   public String configKey() {
@@ -145,8 +148,8 @@ public Map<Integer, Class<? extends Expander>> indexToExpanderClass() {
   }
 
   /**
-   * After {@link #indexToExpanderClass} is populated, this is set by contracts that support
-   * runtime injection.
+   * After {@link #indexToExpanderClass} is populated, this is set by contracts that support runtime
+   * injection.
    */
   public MethodMetadata indexToExpander(Map<Integer, Expander> indexToExpander) {
     this.indexToExpander = indexToExpander;
