私は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 形式のファイル) を生成する方法がわかりません。
だから私は asciidoctor-maven-plugin を使用して HTML ドキュメントを生成するために使用している .ad (asciidoc ファイル) を生成したいと考えています。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>
次の依存関係を使用しています。