add examples to javadoc comments

esaulpaugh · Sep 14, 2024 · e37c898 · e37c898
1 parent a81ccf5
commit e37c898
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/src/main/java/com/esaulpaugh/headlong/abi/TupleType.java b/src/main/java/com/esaulpaugh/headlong/abi/TupleType.java
@@ -77,7 +77,16 @@ public String getElementInternalType(int index) {
 
     /**
      * If the compiler can't infer the return type, use a type witness.
-     *
+     * <p>
+     * From Java:
+     * <blockquote><pre>
+     *     {@code TypeFactory.<TupleType<Single<Integer>>>create("(int8)").<ABIType<Integer>>get(0).encode(12)}
+     * </pre></blockquote><p>
+     * <p>
+     * From Kotlin:
+     * <blockquote><pre>
+     *     {@code TypeFactory.create<TupleType<Single<Int>>>("(int8)").get<ABIType<Int>>(0).encode(12)}
+     * </pre></blockquote><p>
      * @param index
      * @return
      * @param <T>

diff --git a/src/main/java/com/esaulpaugh/headlong/abi/TypeFactory.java b/src/main/java/com/esaulpaugh/headlong/abi/TypeFactory.java
@@ -107,7 +107,16 @@ private static void mapByteArray(Map<String, ABIType<?>> map, String type, int a
 
     /**
      * If the compiler can't infer the return type, use a type witness.
-     *
+     * <p>
+     * From Java:
+     * <blockquote><pre>
+     *     {@code TypeFactory.<TupleType<Single<Integer>>>create("(int8)").<ABIType<Integer>>get(0).encode(12)}
+     * </pre></blockquote><p>
+     * <p>
+     * From Kotlin:
+     * <blockquote><pre>
+     *     {@code TypeFactory.create<TupleType<Single<Int>>>("(int8)").get<ABIType<Int>>(0).encode(12)}
+     * </pre></blockquote><p>
      * @param rawType
      * @return
      * @param <T>