MarkdownComments.java

package org.javademos.java23.jep467;

import org.javademos.commons.IDemo;

/// # Demo for JDK 23 feature JEP 467 - Markdown Documentation Comments
///
/// ## JEP history
/// - JDK 23: [JEP 467 - Markdown Documentation Comments](https://openjdk.org/jeps/467)
///
/// ## Further reading
/// - [Java Enhances Documentation with Markdown Support](https://www.infoq.com/news/2024/05/jep467-markdown-in-javadoc/)
///
/// @author alois.seckar@gmail.com

@SuppressWarnings("DanglingJavadoc") // because of the examples
public class MarkdownComments implements IDemo {
    @Override
    public void demo() {
        info(467);
    }

    // Markdown syntax is now possible in Javadoc comments
    // It has to be started with different prefix - /// instead of /**

    // BEFORE JDK 23 - Javadoc header

    /**
     * <h1>
     *   Demo for JDK 23 feature <strong>JEP 467 - Markdown Documentation Comments</strong>
     * </h1>
     */

    // AFTER JDK 23 - Javadoc header

    /// # Demo for JDK 23 feature **JEP 467 - Markdown Documentation Comments**

    // ISSUES / LIMITATIONS

    // @see and external links
    // -----------------------
    // /// @see [JEP 467](https://openjdk.org/jeps/467)
    // md syntax is currently not possible
    // /// @see <a href="https://openjdk.org/jeps/467">JEP 467</a>
    // html <a> tag renders fine...

}