JarCasting
JarCasting JarCasting

Javadoc to Properties Converter

This library generates a properties file from Java source files' Javadocs. It is implemented as Doclet and to be used together with `javadoc`.

License

License
GroupId

GroupId

de.ohmesoftware
ArtifactId

ArtifactId

javadoctoproperties-java9
Last Version

Last Version

0.0.4
Release Date

Release Date
Type

Type

jar
Description

Description

Javadoc to Properties Converter
This library generates a properties file from Java source files' Javadocs. It is implemented as Doclet and to be used together with `javadoc`.
Project URL

Project URL

https://github.com/kaoh/javadoctoproperties
Source Code Management

Source Code Management

https://github.com/kaoh/javadoctoproperties/tree/masterjava9+

Download javadoctoproperties-java9

Filename Size
javadoctoproperties-java9-0.0.4.pom
javadoctoproperties-java9-0.0.4.jar 12 KB
javadoctoproperties-java9-0.0.4-sources.jar 5 KB
javadoctoproperties-java9-0.0.4-javadoc.jar 393 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/de.ohmesoftware/javadoctoproperties-java9/ -->
<dependency>
    <groupId>de.ohmesoftware</groupId>
    <artifactId>javadoctoproperties-java9</artifactId>
    <version>0.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/de.ohmesoftware/javadoctoproperties-java9/
implementation 'de.ohmesoftware:javadoctoproperties-java9:0.0.4'
// https://jarcasting.com/artifacts/de.ohmesoftware/javadoctoproperties-java9/
implementation ("de.ohmesoftware:javadoctoproperties-java9:0.0.4")
'de.ohmesoftware:javadoctoproperties-java9:jar:0.0.4'
<dependency org="de.ohmesoftware" name="javadoctoproperties-java9" rev="0.0.4">
  <artifact name="javadoctoproperties-java9" type="jar" />
</dependency>
@Grapes(
@Grab(group='de.ohmesoftware', module='javadoctoproperties-java9', version='0.0.4')
)
libraryDependencies += "de.ohmesoftware" % "javadoctoproperties-java9" % "0.0.4"
[de.ohmesoftware/javadoctoproperties-java9 "0.0.4"]

Dependencies

test (1)

Group / Artifact Type Version
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

Introduction

This library generates a properties file as string as output from Java source files' Javadocs. It is implemented as Doclet and to be used together with javadoc.

Features

The library in its current state was created for getting a data model documentation of entities or DTOs for the ALPS or JSON schema documentation used in Spring Data REST API. It is also useful for the OpenAPI documentation (former Swagger) using property files in the annotations, e.g. in ApiModelProperty support by SpringFox.

It is using the Doclet API internally.

This is the first version and has the following limitations:

  • No methods are scanned
  • No tags are used

Usage

Cmd Line:

        javadoc -doclet de.ohmesoftware.javadoctoproperties.Converter -docletpath target/classes -sourcepath src/main/java de.example.my.model

Maven

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.1.0</version>
                <executions>
                    <execution>
                        <id>javadoc-test</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <phase>test</phase>
                        <configuration>
                            <doclet>de.ohmesoftware.javadoctoproperties.Converter</doclet>
                            <additionalOptions>-prefix rest.description -output src/main/resources/mydocs.properties</additionalOptions>
                            <debug>true</debug>
                            <docletPath>${project.build.outputDirectory}</docletPath>
                            <sourcepath>${project.basedir}/src/main/java/foo/bar/model</sourcepath>
                        </configuration>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>de.ohmesoftware</groupId>
                        <artifactId>javadoctoproperties</artifactId>
                        <version>0.0.1-SNAPSHOT</version>
                    </dependency>
                </dependencies>
            </plugin>

Deployment + Release

See https://central.sonatype.org/pages/apache-maven.html

For Snapshots

mvn clean deploy

For Releases

mvn release:clean release:prepare
mvn release:perform

Release the deployment using Nexus See https://central.sonatype.org/pages/releasing-the-deployment.html Or alternatively do it with Maven:

cd target/checkout
mvn nexus-staging:release

Versions

Version
0.0.4
0.0.3