Module io.helidon.codegen
Package io.helidon.codegen

Class JavadocWriter

java.lang.Object
io.helidon.codegen.JavadocWriter
public final class JavadocWriter extends Object
A tool that renders Javadoc to simplified HTML.

The following inline tags are rendered, all other inline tags are ignored:

  • summary: rendered as <summary>
  • value: rendered as <code>
  • code: rendered as <code>
  • literal: rendered as <code>
  • link: rendered as <code>
  • linkplain: rendered as <code>

Block tags ignored.

HTML elements are re-rendered from the parsed tree.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

  • Method Details

    • create

      public static JavadocWriter create(StringBuilder buf)
      Create a new instance.
      Parameters:
      buf - buf
      Returns:
      writer

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • write

      public void write(List<? extends JavadocTree> elements)
      Write the given elements.
      Parameters:
      elements - elements

    • write

      public void write(JavadocTree element)
      Write the given element.
      Parameters:
      element - element