The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Javadoc Plugin

View this plugin on the Plugins site

javadoc: Publish Javadoc

Adds Javadoc support to Jenkins jobs.

The plugin provides a "Publish Javadoc" post-build action, specifying the directory where the Javadoc is to be gathered and if retention is expected for each successful build.

Pipeline jobs can publish Javadoc using the javadoc step.

  • javadocDir : String
    Directory that contains the Javadoc that is to be published for the build.
  • keepAll : boolean
    If you check this option, Jenkins will retain Javadoc for each successful build. This allows you to browse Javadoc for older builds, at the expense of additional disk space requirement.

    If you leave this option unchecked, Jenkins will only keep the latest Javadoc, so older Javadoc will be overwritten as new builds succeed.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.