Abnaxos / markdown-doclet

A Doclet that allows the use of Markdown in JavaDoc comments.
GNU General Public License v3.0
319 stars 40 forks source link

Adds an option to use doclava doclet instead of standard as a base one #86

Closed vgrachev closed 6 years ago

vgrachev commented 6 years ago

Although, doclava has not been updated for a while it still works and has nice features like:

Since markdown doclet doesn’t actually replace the standard one, but works on top of it, it’s quite easy to substitute it with doclava.

Current implementation checks if doclava doclet is in classpath and uses it if it is. If doclava is not in classpath, standard doclet is used.

Example of usage in build.gradle:

        configurations {
            doclava
        }

        dependencies {
            doclava 'ch.raffael.mddoclet.markdown-doclet:jdk8:2.0+'
            doclava 'net.sourceforge.plantuml:plantuml:8059'
            doclava 'com.google.doclava:doclava:1.0.6'
        }

        javadoc {
            dependsOn project.configurations.doclava
            title = null
            options.doclet = "ch.raffael.mddoclet.MarkdownDoclet"
            options.docletpath = configurations.doclava.files.asType(List)
            options.addStringOption 'hdf project.name', “My Project“
        }
Abnaxos commented 6 years ago

Sorry, I'll have to reject this one. v1 is end-of-life. I know, I should put more time into v2, but that's exactly the reason why I insist on this.

With Java 9, a now doclet API has been introduced and, if I'm informed correctly, the old one has been dropped with Java 10. So, getting v2 done is top priority.