enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-11-22 03:32:23 +03:00
Code Issues Projects Releases Wiki Activity

Include also the documentation in the generated files

Browse Source
This commit is contained in:
Jaroslav Tulach 2024-06-15 09:07:32 +02:00
parent b10ae4627d
commit 87b502628f
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
engine/runtime-compiler/src/main/java/org/enso/compiler/dump/GenerateDocs.java
View File

@ -4,6 +4,8 @@ import java.io.IOException;
import org.enso.compiler.context.CompilerContext;
import org.enso.compiler.core.ir.module.scope.Definition;
import org.enso.compiler.core.ir.module.scope.definition.Method;
import org.enso.compiler.pass.resolve.DocumentationComments;
import org.enso.compiler.pass.resolve.DocumentationComments$;
import org.enso.filesystem.FileSystem;
import scala.collection.immutable.Seq;
import scala.jdk.CollectionConverters;
@ -43,13 +45,19 @@ public final class GenerateDocs {
for (var b : asJava(ir.bindings())) {
switch (b) {
case Definition.Type t -> w.append("- **type** " + t.name().name() + "\n");
case Definition.Data d -> w.append("- data " + d.name().name() + "\n");
case Definition.SugaredType s -> w.append("- sugar " + s.name().name() + "\n");
case Method.Explicit m -> w.append("- method " + m.methodName().name() + "\n");
case Method.Conversion c -> w.append("- conversion " + c.methodName().name() + "\n");
case Definition.Type t -> w.append("#### **type** " + t.name().name() + "\n");
case Definition.Data d -> w.append("#### data " + d.name().name() + "\n");
case Definition.SugaredType s -> w.append("#### sugar " + s.name().name() + "\n");
case Method.Explicit m -> w.append("#### method " + m.methodName().name() + "\n");
case Method.Conversion c -> w.append("#### conversion " + c.methodName().name() + "\n");
default -> throw new AssertionError("unknown type " + b.getClass());
}
var option = b.passData().get(DocumentationComments$.MODULE$);
if (option.isDefined()) {
var doc = (DocumentationComments.Doc) option.get();
w.append(doc.documentation());
w.append("\n\n\n");
}
}
}
}