Orchid Javadoc

docs official


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.



Basic Usage

Once the Javadoc plugin is added to your build, you need to tell Orchid where it can find your Java code. This is set in your config.yml as a list of file paths to the root package for your code.

A typical use-case is to have Orchid be in a separate Gradle subproject than the code it's documenting. For example, using docs and app subprojects with the following standard Gradle/Maven project structure:

. / (repo root)
├── app
|   └── src/main/java/ <-- this is the directory you need to reference
|       └── com/example/
|           └── Main.java
└── docs
    └── src/orchid/resources/ <-- these are your Orchid resources
        ├── homepage.md
        └── config.yml

Your config.yml can specify a relative path from your Orchid resources to your Java code source root:

    - './../../../../app/src/main/java'

Setting multiple sourceDirs will include them all in the generated documentation.

OrchidJavadoc ships with several menu item types that are useful for creating docs with a similar feel to standard Javadoc sites. The javadocClasses and javadocPackages simply link to all generated class and package pages, like the sidebar frames on typical Javadoc pages.

javadocClassLinks creates links to each individual field, constructor, and method documented in a class page, similar to the "summary" section of typical Javadoc pages. It can only be added to Javadoc class pages.

All three of these menu items are best added to the Javadoc page Archetypes in config.yml:

  classPages: # <-- applied only to Javadoc class pages
      - type: "javadocClassLinks"
  pages:  # <-- applied to Javadoc class and package pages
      - type: "javadocClasses"
      - type: "javadocPackages"
Include with:
dependencies {
    orchidRuntime 'io.github.javaeden.orchid:OrchidJavadoc:0.17.7'