Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.mnlipp:jdrupes-mdoclet:1.1.1'
	}

	dependencies {
		implementation("com.github.mnlipp:jdrupes-mdoclet:1.1.1")
	}

	<dependency>
	    <groupId>com.github.mnlipp</groupId>
	    <artifactId>jdrupes-mdoclet</artifactId>
	    <version>1.1.1</version>
	</dependency>


                            
    libraryDependencies += "com.github.mnlipp" % "jdrupes-mdoclet" % "1.1.1"


                            
    :dependencies [[com.github.mnlipp/jdrupes-mdoclet "1.1.1"]]

MDoclet

With Java 23 having "native" support for Markdown comments, there will be no future versions of this doclet. The way to go is to start adapting your comments now and use Java 23 for Javadoc generation in your build, even if you use some older version of Java for compilation.

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.

mnlipp/jdrupes-mdoclet

A javadoc doclet that handles Markdown comments

Download

Readme

MDoclet