org.jdrupes:org.jdrupes.mdoclet-gradle-plugin

A doclet for processing javadoc comments written with Markup


Keywords
doclet, javadoc, markdown
License
GPL-3.0

Documentation

MDoclet

Java CI Maven Central

Please note that starting with version 2.0.0 the doclet works with the API introduced in Java 9. It has been tested with Java 11.

A Doclet that allows the use of Markdown in JavaDoc. It uses a configurable Markdown processor (flexmark-java by default). Basically, the doclet intercepts the standard doclet's access to the AST generated by the javadoc tool and converts the texts from the comments from markdown to HTML.

See the javadoc overview for details.

  • Version 4.0.0 supports/requires Java-21.

  • Version 3.0.0 supports/requires Java-17.

  • Version 2.2.0 avoids a warning when using @see tags with quoted strings.

  • Version 2.1.0 fixes a problem that caused a class cast exception with JDK 15+ when javadoc tries to report a warning.

This Doclet is released under the AGPL 3.0.