Add Javadoc to Asciidoc converter #101
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppkarwasz
force-pushed
the
feature/asciidoctor-converter
branch
from
d022f04
to
327a78d
Compare
ppkarwasz
force-pushed
the
feature/asciidoctor-converter
branch
from
327a78d
to
40e29fc
Compare
vy
requested changes
Feb 6, 2024
...gen/src/main/java/org/apache/logging/log4j/docgen/processor/AbstractAsciidocTreeVisitor.java
Outdated
Show resolved
Hide resolved
...gen/src/main/java/org/apache/logging/log4j/docgen/processor/AbstractAsciidocTreeVisitor.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/AsciidocConverter.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/internal/RowImpl.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/internal/SectionImpl.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/internal/TableImpl.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/test/resources/expected/processor/JavadocExample.adoc
Outdated
Show resolved
Hide resolved
We add a converter between Javadoc and Asciidoc that converts: * from a [`DocCommentTree`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.compiler/com/sun/source/doctree/DocCommentTree.html), provided by the `javac` compiler or `javadoc` tool, * to an AsciiDoctorJ [`Document`](https://javadoc.io/static/org.asciidoctor/asciidoctorj/3.0.0-alpha.2/org/asciidoctor/ast/Document.html). We provide a primitive implementation of the AsciiDoctorJ API that converts the AST back into a text document.
Finalize and otherwise protect implementation classes. Co-authored-by: Volkan Yazıcı <volkan@yazi.ci>
ppkarwasz
force-pushed
the
feature/asciidoctor-converter
branch
from
9de5f56
to
6e01fa9
Compare
ppkarwasz
force-pushed
the
feature/asciidoctor-converter
branch
from
d34a4b0
to
aa56053
Compare
If we encounter a `<pre>` element with content containing XML elements, we classify it as XML, otherwise Java. The maximal common indentation is stripped from the content of a `<pre>` tag.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We add a converter between Javadoc and Asciidoc that converts:
DocCommentTree, provided by thejavaccompiler orjavadoctool,Document.We provide a primitive implementation of the AsciiDoctorJ API that converts the AST back into a text document.
Part of apache/logging-log4j2#1956