Javadoc.io Maven Plugin

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

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

org.safris.maven
ArtifactId

ArtifactId

javadocio-maven-plugin
Last Version

Last Version

0.1.2
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

Javadoc.io Maven Plugin
The Javadoc.io Maven Plugin creates JavaDocs that interlink to javadoc.io.
Project URL

Project URL

https://github.com/safris/javadocio-maven-plugin
Project Organization

Project Organization

Seva Safris
Source Code Management

Source Code Management

https://github.com/safris/javadocio-maven-plugin

Download javadocio-maven-plugin

How to add to project

<plugin>
    <groupId>org.safris.maven</groupId>
    <artifactId>javadocio-maven-plugin</artifactId>
    <version>0.1.2</version>
</plugin>

Dependencies

compile (3)

Group / Artifact Type Version
org.apache.maven.plugins : maven-javadoc-plugin jar 3.0.1
org.apache.maven.plugins : maven-dependency-plugin jar 3.1.0
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.6.0

test (1)

Group / Artifact Type Version
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

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.

Versions

Version
0.1.2
0.1.1
0.1.0