Add ix doc comments. TODO: map to javadac html5

Author: jpe7s

anchor-src-gen/src/main/java/software/sava/anchor/AnchorAccountMetaParser.java

@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.function.Supplier;
 
+import static software.sava.anchor.AnchorUtil.parseDocs;
 import static software.sava.anchor.IDL.NO_DOCS;
 import static systems.comodal.jsoniter.JsonIterator.fieldEquals;
 
@@ -72,11 +73,7 @@ public boolean test(final char[] buf, final int offset, final int len, final Jso
     } else if (fieldEquals("desc", buf, offset, len)) {
       this.desc = ji.readString();
     } else if (fieldEquals("docs", buf, offset, len)) {
-      final var docs = new ArrayList<String>();
-      while (ji.readArray()) {
-        docs.add(ji.readString());
-      }
-      this.docs = docs;
+      this.docs = parseDocs(ji);
     } else if (fieldEquals("isMut", buf, offset, len) || fieldEquals("writable", buf, offset, len)) {
       this.writable = ji.readBoolean();
     } else if (fieldEquals("optional", buf, offset, len) || fieldEquals("isOptional", buf, offset, len)) {

anchor-src-gen/src/main/java/software/sava/anchor/AnchorIDL.java

@@ -11,6 +11,7 @@
 import java.util.stream.Collectors;
 
 import static software.sava.anchor.AnchorSourceGenerator.removeBlankLines;
+import static software.sava.anchor.AnchorUtil.parseDocs;
 import static systems.comodal.jsoniter.JsonIterator.fieldEquals;
 import static systems.comodal.jsoniter.factory.ElementFactory.parseList;
 
@@ -339,11 +340,7 @@ public boolean test(final char[] buf, final int offset, final int len, final Jso
       } else if (fieldEquals("metadata", buf, offset, len)) {
         this.metaData = AnchorIdlMetadata.parseMetadata(ji);
       } else if (fieldEquals("docs", buf, offset, len)) {
-        final var docs = new ArrayList<String>();
-        while (ji.readArray()) {
-          docs.add(ji.readString());
-        }
-        this.docs = docs;
+        this.docs = parseDocs(ji);
       } else {
         throw new IllegalStateException("Unhandled AnchorIDL field " + new String(buf, offset, len));
       }

anchor-src-gen/src/main/java/software/sava/anchor/AnchorInstruction.java

@@ -15,6 +15,7 @@
 
 public record AnchorInstruction(Discriminator discriminator,
                                 String name,
+                                List<String> docs,
                                 List<AnchorAccountMeta> accounts,
                                 List<NamedType> args) {
 
@@ -53,7 +54,8 @@ private static String formatDiscriminator(final String ixName, final Discriminat
     return Arrays.stream(discriminator.toIntArray())
         .mapToObj(Integer::toString)
         .collect(Collectors.joining(", ",
-            String.format("  public static final Discriminator %s = toDiscriminator(", formatDiscriminatorReference(ixName)), ");"));
+            String.format("  public static final Discriminator %s = toDiscriminator(", formatDiscriminatorReference(ixName)), ");"
+        ));
   }
 
   public String generateFactorySource(final GenSrcContext genSrcContext, final String parentTab) {
@@ -90,7 +92,8 @@ public String generateFactorySource(final GenSrcContext genSrcContext, final Str
         for (final var accountsClas : knownAccountClasses) {
           keyParamsBuilder.append(String.format("""
               final %s %s,
-              """, accountsClas.getSimpleName(), AnchorUtil.camelCase(accountsClas.getSimpleName(), false)));
+              """, accountsClas.getSimpleName(), AnchorUtil.camelCase(accountsClas.getSimpleName(), false)
+          ));
           genSrcContext.addImport(accountsClas);
         }
       }
@@ -175,6 +178,11 @@ public String generateFactorySource(final GenSrcContext genSrcContext, final Str
       dataSerialization = dataBuilder.toString();
     }
 
+    if (docs != null && !docs.isEmpty()) {
+      for (final var doc : docs) {
+        builder.append(tab).append("// ").append(doc).append('\n');
+      }
+    }
     final var methodSignature = String.format("%spublic static Instruction %s(", tab, name);
     builder.append(methodSignature);
 
@@ -211,13 +219,15 @@ public String generateFactorySource(final GenSrcContext genSrcContext, final Str
                 return Instruction.createInstruction(%s, keys, _data);
               }
               """,
-          programMetaReference).indent(parentTab.length()));
+          programMetaReference
+      ).indent(parentTab.length()));
     } else {
       builder.append(String.format("""          
                 return Instruction.createInstruction(%s, keys, %s);
               }
               """,
-          programMetaReference, discriminatorReference).indent(parentTab.length()));
+          programMetaReference, discriminatorReference
+      ).indent(parentTab.length()));
     }
     genSrcContext.addImport(Instruction.class);
 

anchor-src-gen/src/main/java/software/sava/anchor/AnchorInstructionParser.java

@@ -7,13 +7,15 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static software.sava.anchor.AnchorUtil.parseDocs;
 import static systems.comodal.jsoniter.JsonIterator.fieldEquals;
 
 final class AnchorInstructionParser implements ElementFactory<AnchorInstruction> {
 
   private final IDLType idlType;
   private Discriminator discriminator;
   private String name;
+  private List<String> docs;
   private List<AnchorAccountMeta> accounts;
   private List<NamedType> args;
 
@@ -54,6 +56,7 @@ public AnchorInstruction create() {
         return new AnchorInstruction(
             discriminator,
             name,
+            docs,
             accumulateNestedAccounts(),
             args
         );
@@ -62,6 +65,7 @@ public AnchorInstruction create() {
     return new AnchorInstruction(
         discriminator,
         name,
+        docs,
         accounts,
         args
     );
@@ -77,6 +81,8 @@ public boolean test(final char[] buf, final int offset, final int len, final Jso
       this.discriminator = AnchorUtil.parseDiscriminator(ji);
     } else if (fieldEquals("name", buf, offset, len)) {
       this.name = AnchorUtil.camelCase(ji.readString(), false);
+    } else if (fieldEquals("docs", buf, offset, len)) {
+      this.docs = parseDocs(ji);
     } else {
       ji.skip();
     }

anchor-src-gen/src/main/java/software/sava/anchor/AnchorNamedTypeParser.java

@@ -5,10 +5,10 @@
 import systems.comodal.jsoniter.ValueType;
 import systems.comodal.jsoniter.factory.ElementFactory;
 
-import java.util.ArrayList;
 import java.util.List;
 
 import static software.sava.anchor.AnchorType.ANCHOR_TYPE_PARSER;
+import static software.sava.anchor.AnchorUtil.parseDocs;
 import static systems.comodal.jsoniter.JsonIterator.fieldEquals;
 
 final class AnchorNamedTypeParser extends BaseNamedTypeParser {
@@ -56,11 +56,7 @@ public boolean test(final char[] buf, final int offset, final int len, final Jso
     if (fieldEquals("discriminator", buf, offset, len)) {
       this.discriminator = AnchorUtil.parseDiscriminator(ji);
     } else if (fieldEquals("docs", buf, offset, len)) {
-      final var docs = new ArrayList<String>();
-      while (ji.readArray()) {
-        docs.add(ji.readString());
-      }
-      this.docs = docs;
+      this.docs = parseDocs(ji);
     } else if (fieldEquals("fields", buf, offset, len)) {
       this.type = AnchorTypeContextList.createList(ElementFactory.parseList(ji, idlType.lowerTypeParserFactory(), this));
     } else if (fieldEquals("index", buf, offset, len)) {

anchor-src-gen/src/main/java/software/sava/anchor/AnchorUtil.java

@@ -4,6 +4,7 @@
 import software.sava.core.programs.Discriminator;
 import systems.comodal.jsoniter.JsonIterator;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import static java.util.Arrays.copyOfRange;
@@ -218,6 +219,14 @@ public static String camelCase(final String maybeSnakeCase, final boolean firstU
     return !changedFirst && c == len ? maybeSnakeCase : new String(buf, 0, c);
   }
 
+  static List<String> parseDocs(final JsonIterator ji) {
+    final var docs = new ArrayList<String>();
+    while (ji.readArray()) {
+      docs.add(ji.readString()); // .replace('`', '"')
+    }
+    return docs;
+  }
+
   private AnchorUtil() {
   }
 }