OrchidJavadoc

Where Orchid began. Create beautiful Javadocs for your project within your Orchid site.


About

The OrchidJavadoc plugin integrates with the Javadoc tool to embed class and package info from Java and Java source code directly in your Orchid site. Comment text is compiled as Markdown, and is also fully-searchable with the OrchidSearch plugin.

The behavior of the OrchidJavadoc is changing. Please see the 0.18.0 Migration Guide for more details.

This plugin is being deprecated in favor of a new, more unified, and more modular code-documentation plugin, OrchidSourceDoc. All configuration will be defined by that plugin, and this plugin will simply provide Java language support for that plugin.

The new system is currently experimental and is an opt-in feature for 0.18.x Orchid versions. It can be enabled now with the --experimentalSourceDoc CLI flag. The legacy behavior is scheduled for removal in version 0.19.0.

Demo

Usage

The article How to Document a Kotlin Project is the best way to get started using Orchid for code documentation, check it out for a beginning-to-end guide to using Orchid.

While this article is specific to the Kotlin language support in Orchid, working with Java in Orchid is almost identical, with the specifics outlined in the example app.

dependencies {
    orchidRuntime("io.github.javaeden.orchid:OrchidJavadoc:0.20.0")
}
<dependency>
    <groupId>io.github.javaeden.orchid</groupId>
    <artifactId>OrchidJavadoc</artifactId>
    <version>0.20.0</version>
    <type>pom</type>
</dependency>
@file:DependsOn("io.github.javaeden.orchid:OrchidJavadoc:0.20.0")