我是asciidoc的新手。我想在java文件中用注释的javadoc(asciidoc格式)生成HTML文档。
例如java文件
/**
* = Asciidoclet
*
* Sample comments that include `source code`.
*
* [source,java]
* --
* public class Asciidoclet extends Doclet {
* private final Asciidoctor asciidoctor = Asciidoctor.Factory.create();
*
* @SuppressWarnings("UnusedDeclaration")
* public static boolean start(RootDoc rootDoc) {
* new Asciidoclet().render(rootDoc);
* return Standard.start(rootDoc);
* }
* }
* --
*
* @author https://github.com/johncarl81[John Ericksen]
*/
public class Asciidoclet extends Doclet {
}
我可以从.ad文件生成html文件,但我不知道如何从javadoc生成.ad(或任何asciidoc格式文件)。
所以我想生成.ad(asciidoc文件),我使用asciidoctor-maven-plugin生成html文档。 asciidoctor-maven-plugin将检查sourceDirectory中的.ad文件,并在outputDirectory中生成html文件。
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor.version}</version>
<executions>
<execution>
<id>output-html</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
</execution>
</executions>
<configuration>
<sourceDirectory>asciidocs</sourceDirectory>
<outputDirectory>asciidocs-output</outputDirectory>
<backend>html</backend>
<doctype>book</doctype>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<configuration>
<source>1.7</source>
<doclet>org.asciidoctor.Asciidoclet</doclet>
<docletArtifact>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoclet</artifactId>
<version>${asciidoclet.version}</version>
</docletArtifact>
<overview>src/main/java/overview.adoc</overview>
<additionalparam>
--base-dir ${project.basedir}
--attribute "name=${project.name}"
--attribute "version=${project.version}"
--attribute "title-link=http://example.com[${project.name} ${project.version}]"
</additionalparam>
</configuration>
</plugin>
依赖
<asciidoclet.version>1.5.0</asciidoclet.version>
<asciidoctor.version>1.5.0</asciidoctor.version>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>1.5.2</version>
</dependency>
我提到asciidoclet,但我无法获得任何有用的信息。所有示例项目都用于生成html,pdf,epub等。
感谢...
更新
我改变了我的maven-javadoc-plugin配置如下并执行mvn org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar
但是它生成正常的html java文件它应该生成.adoc文件。
任何人都能帮我解决我做错的事吗?
感谢...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<executions>
<execution>
<id>javadoc-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<includeDependencySources>true</includeDependencySources>
<dependencySourceExcludes>
<dependencySourceExclude>commons-cli:*</dependencySourceExclude>
</dependencySourceExcludes>
<source>1.7</source>
<doclet>org.asciidoctor.Asciidoclet</doclet>
<docletArtifact>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoclet</artifactId>
<version>${asciidoclet.version}</version>
</docletArtifact>
<overview>src/main/java/overview.adoc</overview>
<additionalparam>
--base-dir ${project.basedir}
--attribute "name=${project.name}"
--attribute "version=${project.version}"
--attribute "title-link=http://example.com[${project.name} ${project.version}]"
</additionalparam>
</configuration>
</execution>
</executions>
</plugin>
我使用以下依赖项。
答案 0 :(得分:1)
看起来你对Asciidoclet正在做的事情有点过分了。它不是为了创建Asciidoc而设计的,而是为了能够在Asciidoc中编写javadoc,然后将其转换为javadoc命令的html输出。
你可能想要研究的是为asciidoctor构建一个自定义包含模块,它将获取你的asciidoc javadoc源代码,删除java注释并将其包含在你正在创建的其他输出中。