https://github.com/mnlipp/jdrupes-mdoclet

A javadoc doclet that handles Markdown comments
https://github.com/mnlipp/jdrupes-mdoclet

doclet javadoc markdown

Last synced: about 1 year ago
JSON representation

A javadoc doclet that handles Markdown comments

• Host: GitHub
• URL: https://github.com/mnlipp/jdrupes-mdoclet
• Owner: mnlipp
• License: agpl-3.0
• Created: 2017-02-22T17:02:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-11-29T06:59:40.000Z (over 2 years ago)
• Last Synced: 2023-11-29T07:38:15.420Z (over 2 years ago)
• Topics: doclet, javadoc, markdown
• Language: Java
• Size: 8.86 MB
• Stars: 18
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
MDoclet

=======

[![Java CI](https://github.com/mnlipp/jdrupes-mdoclet/actions/workflows/main.yml/badge.svg)](https://github.com/mnlipp/jdrupes-mdoclet/actions/workflows/main.yml)

[![Maven Central](https://img.shields.io/maven-central/v/org.jdrupes.mdoclet/doclet.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.jdrupes.mdoclet%22%20AND%20a%3A%22doclet%22)

**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](https://github.com/vsch/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](https://mnlipp.github.io/jdrupes-mdoclet/javadoc/)

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](http://www.gnu.org/licenses/#AGPL).