Class Include

java.lang.Object
org.apache.sis.internal.doclet.Taglet
org.apache.sis.internal.doclet.Include
All Implemented Interfaces:
jdk.javadoc.doclet.Taglet

public final class Include extends Taglet
The @include tag for inserting a HTML fragment defined in an external file. This tag is used mostly for formulas written in MathML. Those formulas are provided in separated files for easier edition and for avoiding errors with compilers that verify the HTML tags (e.g. JDK 8 javac). Fragment of the external files are inserted in the Javadoc by the following tag:
{@include formulas.html#title}
where title is the text inside <h2>…</h2> elements just before the parts to copy in the javadoc.
Since:
0.5
Version:
1.0
  • Field Details

    • ANCHOR_START

      private static final String ANCHOR_START
      The beginning and the end of the anchor texts. Must be on the same line.
      See Also:
    • ANCHOR_END

      private static final String ANCHOR_END
      The beginning and the end of the anchor texts. Must be on the same line.
      See Also:
    • DOCUMENT_END

      private static final String DOCUMENT_END
      End of document.
      See Also:
  • Constructor Details

    • Include

      public Include()
      Constructs an @include taglet.
  • Method Details

    • getName

      public String getName()
      Returns the name of this custom tag.
      Returns:
      "include".
    • format

      protected void format(com.sun.source.doctree.DocTree tag, StringBuilder buffer)
      Given the DocTree representation of this custom tag, appends its string representation.
      Specified by:
      format in class Taglet
      Parameters:
      tag - the tag to format.
      buffer - the buffer where to format the tag.