A javadoc doclet that handles Markdown comments
CSS Java Groovy
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.settings
gradle/wrapper
integrations
mdoclet
.classpath
.codeclimate.yml
.gitignore
.project
.travis.yml
LICENSE.txt
README.md
build.gradle
checkstyle.xml
gradlew
gradlew.bat
settings.gradle

README.md

MDoclet

Build Status Codacy Badge Code Climate Release Maven Central

A Doclet that allows the use of Markdown in JavaDoc. It uses a configurable Markdown processor (flexmark-java by default). It's a simple preprocessor to the standard Doclet: It processes all JavaDoc comments in the documentation tree and then forwards the result to the standard Doclet.

See the javadoc package description for details.

This project is an architectural redesign of Abnaxos' great pegdown-doclet. As its name suggests, pegdown-doclet is closely tied to pegdown, which is now deprecated. pegdown-doclet's PlanUML integration has been factored out in the independent project org.jdrupes.taglets.

This doclet is released under the GPL 3.0.