DOC

org.neo4j.build.plugins : clirr-maven-plugin

Maven & Gradle

Nov 10, 2015

Clirr Maven Plugin · This is a specialized version of the Clirr Maven Plugin. It adds capabilities for excluding specific error types, as well as separating code into three, rather than two, subgroups: Internal code (no checks) Externally invoked code (Annotated with an "externally invoked" annotation, same as Externally implemented, but adding methods to interfaces and abstract classes is allowed) Externally implemented code (Assumed default. Full backwards compatibility required *unless* an interface is annotated with a defined adaptor annotation, in which case full backwards compatibility is required for the adaptor class, but the rules of @ExternallyInvoked apply to the interface itself) Clirr is a tool that checks Java libraries for binary and source compatibility with older releases. Basically you give it two sets of jar files and Clirr dumps out a list of changes in the public API. The clirr-maven-plugin can be configured to break the build, if it detects incompatible api changes. In a continuous integration process, the clirr-maven-plugin can automatically prevent accidental introduction of binary or source compatibility problems. Additionally, the plugin can generate a report as part of the generated site.

Table Of Contents

Latest Version

Download org.neo4j.build.plugins : clirr-maven-plugin Javadoc & API Documentation - Latest Versions:

All Versions

Download org.neo4j.build.plugins : clirr-maven-plugin Javadoc & API Documentation - All Versions:

Version Size Javadoc Updated
1.0.x
1.0

How to open Javadoc JAR file in web browser

  1. Rename the file clirr-maven-plugin-1.0.1-javadoc.jar to clirr-maven-plugin-1.0.1-javadoc.zip
  2. Use your favourite unzip tool (WinRAR / WinZIP) to extract it, now you have a folder clirr-maven-plugin-1.0.1-javadoc
  3. Double click index.html will open the index page on your default web browser.

How to generate Javadoc from a source JAR?

Running the command javadoc:

javadoc --ignore-source-errors -encoding UTF-8 -sourcepath "clirr-maven-plugin-1.0.1-sources.jar" -d "clirr-maven-plugin-1.0.1-javadoc" -subpackages 

Advertisement