Tools

Some supporting tools that simplify the setup and application of Japedo can be downloaded for free. They are open source and can be downloaded from Maven Central.

Japedo Maven Plugin

With the generate goal of the Japedo Maven plugin Japedo documentation can be easily generated from an application. The plugin cares for assembling all necessary dependencies by examining the pom.xml files of the application and it's dependencies. Add the following dependency:

<dependency>
     <groupId>com.logitags</groupId>
     <artifactId>japedo-maven-plugin</artifactId>
     <version>1.5.1</version>
</dependency>


Japedo Generator

The Japedo Generator is a frontend for execution of the Japedo Maven plugin which is declared in the pom.xm of a sample application. The Japedo generator application can be applied where the direct execution of Japedo or Japedo Maven plugin is not possible or not desirable e.g. in secured environments, in access restricted environments, to control and restrict execution and permissions. Furthermore, the generated documentation is then pushed to a Git repository where it can be published for example as Gitlab Pages. The Japedo Generator comes in two flavors. When deploying as a standalone application it can be downloaded from Maven Central with

<dependency>
     <groupId>com.logitags</groupId>
     <artifactId>japedoGenerator</artifactId>
     <version>1.1</version>
     <type>war</type>
</dependency>

It can also be embedded in another application as library. Add the following dependency to the application

<dependency>
     <groupId>com.logitags</groupId>
     <artifactId>japedoGenerator</artifactId>
     <version>1.1</version>
     <classifier>lib</classifier>
</dependency>