{asciidoclet-src-ref}[Asciidoclet] is a Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.
== Introduction
Traditionally, Javadocs have mixed minor markup with HTML which, if you're writing for HTML Javadoc output, becomes unreadable and hard to write over time.
This is where lightweight markup languages like {asciidoc-ref}[AsciiDoc] thrive.
AsciiDoc straddles the line between readable markup and beautifully converted content.
Asciidoclet incorporates an AsciiDoc converter (Asciidoctor via the {asciidoctor-java-ref}[Asciidoctor Java integration] library) into a simple Doclet that enables AsciiDoc formatting within Javadoc comments and tags.
== Example
Here's an example of a class with traditional Javadoc.
[source]
.A Java class with traditional Javadoc
/**
Asciidoclet
Sample comments that include {@code source code}.
{@code
public class Asciidoclet extends Doclet {
private final Asciidoctor asciidoctor = Asciidoctor.Factory.create();
{@literal @}SuppressWarnings("UnusedDeclaration")
public static boolean start(RootDoc rootDoc) {
new Asciidoclet().render(rootDoc);
return Standard.start(rootDoc);
}
}
}
@author John Ericksen
*/
public class Asciidoclet extends Doclet {
}
This is the same class with Asciidoclet.
[source]
.A Java class with Asciidoclet Javadoc
/**
= Asciidoclet
Sample comments that include source code.
[source,java]
--
public class Asciidoclet extends Doclet {
private final Asciidoctor asciidoctor = Asciidoctor.Factory.create();
The result is readable source and beautifully converted Javadocs, the best of both worlds!
// tag::usage[]
== Usage
Run Javadoc with the org.asciidoctor.asciidoctlet.Asciidoclet doclet class.
Some examples for common build systems are shown below.
See <> for supported options.
=== Maven
Asciidoclet may be used via a maven-javadoc-plugin doclet:
[source,xml]
org.apache.maven.pluginsmaven-javadoc-plugin3.6.311-J--add-exports=jdk.javadoc/jdk.javadoc.internal.tool=ALL-UNNAMED // <1>
-Xdoclint:all,-html,-accessibility // <2>
org.asciidoctor.asciidoclet.Asciidocletorg.asciidoctorasciidoclet${asciidoclet.version}src/main/java/overview.adoc
--base-dir ${project.basedir}
--attribute "name=${project.name}"
--attribute "version=${project.version}"
--attribute "title-link=https://example.com[${project.name} ${project.version}]"
<1> For the asciidoclet to work, it needs access to the internals of the `javadoc` tool.
This incantation makes that access possible on moduler JDKs.
<2> Asciidoctor may generate HTML that produces doclint errors, which can cause the build to fail.
To work around that, we have to disable these doclint categories.
=== Gradle
Asciidoclet may be used via a doclet in the `Javadoc` task:
[source,groovy]
----
configurations {
asciidoclet
}
dependencies {
asciidoclet 'org.asciidoctor:asciidoclet:1.+'
}
javadoc {
options.docletpath = configurations.asciidoclet.files.asType(List)
options.doclet = 'org.asciidoctor.asciidoclet.Asciidoclet'
options.overview = "src/main/java/overview.adoc"
options.addStringOption "-base-dir", "${projectDir}" // <1>
options.addStringOption "-attribute", // <2>
"name=${project.name}," +
"version=${project.version}," +
"title-link=https://example.com[${project.name} ${project.version}]")
}
----
<1> Option names passed to Gradle's `javadoc` task must omit the leading "-", so here "-base-dir" means "--base-dir".
See <> below.
<2> Gradle's `javadoc` task does not allow multiple occurrences of the same option.
Multiple attributes can be specified in a single string, separated by commas.
=== Ant
// Some of us still use Ant, alright?!
Asciidoclet may be used via a doclet element in Ant's `javadoc` task:
[source,xml]
----
----
<1> Assumes a path reference has been defined for Asciidoclet and its dependencies, e.g.
using https://ant.apache.org/ivy/[Ivy] or similar.
=== Doclet Options
// tag::doclet-options[]
--base-dir ::
Sets the base directory that will be used to resolve relative path names in AsciiDoc `include::` directives.
This should be set to the project's root directory.
-a, --attribute "name[=value], ..."::
Sets https://asciidoctor.org/docs/user-manual/#attributes[document attributes^] that will be expanded in Javadoc comments.
The argument is a string containing a single attribute, or multiple attributes separated by commas.
+
This option may be used more than once, for example: `-a name=foo -a version=1`.
+
Attributes use the same syntax as Asciidoctor command-line attributes:
+
--
* `name` sets the attribute (with an empty value)
* `name=value` assigns `value` to the attribute. Occurrences of `\{name}` in the Javadoc will be replaced by this value.
* `name=value@` assigns `value` to the attribute, unless the attribute is defined in the attributes file or Javadoc.
* `name!` unsets the attribute.
--
+
The document attribute `javadoc` is set automatically by the doclet.
This can be used for conditionally selecting content when using the same AsciiDoc file for Javadoc and other documentation.
--attributes-file ::
Reads https://asciidoctor.org/docs/user-manual/#attributes[document attributes^] from an AsciiDoc file.
The attributes will be expanded in Javadoc comments.
+
If `` is a relative path name, it is assumed to be relative to the `--base-dir` directory.
+
Attributes set by the `-a`/`--attribute` option take precedence over those in the attributes file.
-r, --require ,...::
Make the specified RubyGems library available to Asciidoctor's JRuby runtime, for example `-r asciidoctor-diagram`.
+
This option may be specified more than once.
Alternatively multiple library names may be specified in a single argument, separated by commas.
--gem-path ::
Sets the `GEM_PATH` for Asciidoctor's JRuby runtime.
This option is only needed when using the `--require` option to load additional gems on the `GEM_PATH`.
-overview ::
Overview documentation can be generated from an AsciiDoc file using the standard `-overview` option.
Files matching [x-]`*.adoc`, [x-]`*.ad`, [x-]`*.asciidoc` or [x-]`*.txt` are processed by Asciidoclet.
Other files are assumed to be HTML and will be processed by the standard doclet.
--asciidoclet-include ::
--asciidoclet-exclude ::
Explicitly include or exclude classes from being processed as AsciiDoc comments by ant-style path matching (see https://github.com/azagniotov/ant-style-path-matcher[ant-style-path-matcher]).
+
If `--asciidoclet-include` is specified, only classes and packages matching the include filter are processed.
Likewise, if `--include` is unspecified, all classes are processed.
If `--asciidoclet-exclude` is specified, classes matching the filter are not processed.
+
Both `--asciidoclet-include` and `--asciidoclet-exclude` can be mixed.
In addition, classes excluded with `--asciidoclet-exclude` or not matching a specified `--asciidoclet-include` may be included by annotating the class level javadoc with `@asciidoclet`.
Doing so allows writing one class at a time while respecting refactors.
This feature allows the migration of documentation from HTML to AsciiDoc in a piecemeal way.
// end::doclet-options[]
// end::usage[]
=== Log Warning
Currently, there is an intermittent benign warning message that is emitted during a run of Asciidoclet stating the following:
....
WARN: tilt autoloading 'tilt/haml' in a non thread-safe way; explicit require 'tilt/haml' suggested.
....
Unfortunately, until the underlying library removes this warning message, it will be logged during the build.
== Additional Features
Make sure to see {asciidoclet-release-ref}[Asciidoclet 1.5.0 Release Notes] for additional features not documented here.
== Resources and help
For more information:
* {asciidoclet-release-ref}[Asciidoclet 1.5.0 Release Notes]
* {asciidoclet-src-ref}[Asciidoclet Source Code]
* {asciidoclet-javadoc-ref}[Asciidoclet JavaDoc]
* {asciidoclet-issues-ref}[Asciidoclet Issue Tracker]
* {asciidoctor-src-ref}[Asciidoctor Source Code]
* {asciidoctor-java-src-ref}[Asciidoctor Java Integration Source Code]
If you have questions or would like to help develop this project, please join the {discuss-ref}[Asciidoctor Chat].
ifndef::env-site[]
== Powered by Asciidoclet
We have a <> page.
If you have an example of nifty JavaDoc powered by Asciidoclet, please send us a pull request.
endif::[]
== License
....
Copyright (C) 2013-2015 John Ericksen
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
....