Marklet is a custom Java Doclet which aims to generate a Javadoc in a markdown format which is ready to use in GitHub.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
javadoc/fr/faylixe/marklet
src/main/java/fr/faylixe/marklet
.gitignore
.travis.yml
LICENCE
README.md
pom.xml

README.md

Marklet

Build Status Maven Central Join the chat at https://gitter.im/Faylixe/marklet

Marklet is a custom Java Doclet which aims to generate a Javadoc in a markdown format which is ready to use in GitHub. You can check a Marklet generated javadoc on the following project :

In order to use it with Maven, adds the following configuration for the maven-javadoc-plugin in your project POM :

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-javadoc-plugin</artifactId>
	<version>2.9</version>
	<configuration>
		<doclet>fr.faylixe.marklet.Marklet</doclet>
		<docletArtifact>
			<groupId>fr.faylixe</groupId>
			<artifactId>marklet</artifactId>
			<version>1.1.0</version>
		</docletArtifact>
		<reportOutputDirectory>./</reportOutputDirectory>
		<destDir>./</destDir>
		<additionalparam>-d javadoc/</additionalparam>
		<useStandardDocletOptions>false</useStandardDocletOptions>
	</configuration>
</plugin>

This will generate the javadoc report into the project directory under subfolder javadoc/.

Java8 doclint issues.

If you are using Java8 you may have some issues with doclint validation especially when using markdown blockquotes syntax. To deal with it, just add the following directive to your pom.xml file to deactivate doclint :

<properties>
    <additionalparam>-Xdoclint:none</additionalparam>
</properties>

Developing Marklet

Marklet requires Apache Maven. In order to build, run

$ mvn install

In order to generate Markdown documentation for Marklet itself, run

$ mvn -P marklet-generation javadoc:javadoc

License

Marklet is licensed under the Apache License, Version 2.0

Current issues

The current version is a pre release with the following feature missing :

  • Interfaces, inner classes, enumerations, and annotations has not been tested already and subject to bug.

If you do notice any other error, do not hesitate to submit pull request, or indicates it to the Gitter channel.