Update Javadoc for alias

line · Aug 11, 2022 · 4c06b48 · 4c06b48
1 parent b822357
commit 4c06b48
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/core/src/main/java/com/linecorp/armeria/server/docs/StructInfo.java b/core/src/main/java/com/linecorp/armeria/server/docs/StructInfo.java
@@ -78,6 +78,12 @@ public String name() {
 
     /**
      * Returns the alias of the {@link #name()}.
+     * An alias could be set when a {@link StructInfo} has two different names.
+     *
+     * <p>For example, if a {@link StructInfo} extreact from a {@code com.google.protobuf.Message},
+     * the {@link StructInfo#name()} is set to the full name defined in the proto file and the
+     * {@link StructInfo#alias()} is set to the {@linkplain Class#getName() name} of the generated
+     * {@link Class}.
      */
     @Nullable
     @JsonInclude(Include.NON_NULL)