Skip to content

entinae/javadocio-maven-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JavaDocIO Maven Plugin

Creates JavaDocs that interlink to javadoc.io.

Build Status Coverage Status Javadocs Released Version

The JavaDocIO Maven Plugin creates JavaDocs that interlink to javadoc.io.

Goals Overview

The JavaDocIO Plugin supports two goals.

  • javadoc:javadoc Generates documentation for the Java code in either an aggregator or non-aggregator project.
  • javadoc:jar Bundles the Javadoc documentation for main Java code in an aggregator or non-aggregator aggregator project into a jar.

Configuration Parameters

The javadocio-maven-plugin supports all of the same configuration parameters as the maven-javadoc-plugin, and provides the following additional parameters:

Configuration Property Type Use Description
<detectGeneratedSourcePaths> detectGeneratedSourcePaths boolean Optional If true, the plugin will detect and include the generated source paths from all subpaths of target/generated-sources
Default: false.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.