Please clarify compatibility with Java 17

[serv-inc]

A friend mentioned that Java 17 no longer offers the API to be able to generate a typescript model. Is this correct, or does this project still work on Java 17 and above ?

[alebo611]

I can confirm that I am using Java 17 successfully with this plugin

[ccschneidr]

I cannot confirm that. typescript-generator requires the output of the javadoc xml doclet, which ist not compatible with JDK >= 11. Even a fork of it is not compatible with JDK >= 13. So, I could not find a solution for JDK 17 😭

[ccschneidr]

Aha! A colleague brought up the idea to work without JavaDoc xml file. Comments are missing in that case, but it's better than nothing. So, yes, typescript generator can run with JDK 17, but javadoc xml is not available in that case.

[sh-cho]

Hi, I made this xml-doclet-v2 which uses new Java Doclet API, and with this you can generate Javadoc as XML on Java 11 and above.

e.g.

/**
 * This is class
 */
public class Foo {

    /**
     * This is field
     */
    public Long bar;
}

With xml-doclet-v2, it generates Javadoc xml like below,

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <package name="io.github.shcho">
        <class name="Foo" qualified="io.github.shcho">
            <comment>This is class</comment>
            <field name="bar">
                <comment>This is field</comment>
            </field>
        </class>
    </package>
</root>

And if you generate typescript with Javadoc xml, it generates ts file like below

/**
 * This is class
 */
interface Foo {
    /**
     * This is field
     */
    bar: number;
}

It is published on JitPack (https://jitpack.io/#sh-cho/xml-doclet-v2)