Package org.apache.sis.internal.doclet
Class Include
java.lang.Object
org.apache.sis.internal.doclet.Taglet
org.apache.sis.internal.doclet.Include
- All Implemented Interfaces:
jdk.javadoc.doclet.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:
where title is the text inside{@include formulas.html#title}
<h2>…</h2>
elements
just before the parts to copy in the javadoc.- Since:
- 0.5
- Version:
- 1.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet
jdk.javadoc.doclet.Taglet.Location
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
format
(com.sun.source.doctree.DocTree tag, StringBuilder buffer) Given theDocTree
representation of this custom tag, appends its string representation.getName()
Returns the name of this custom tag.Methods inherited from class org.apache.sis.internal.doclet.Taglet
getAllowedLocations, getCurrentFile, init, isInlineTag, printError, printWarning, text, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jdk.javadoc.doclet.Taglet
isBlockTag
-
Field Details
-
ANCHOR_START
The beginning and the end of the anchor texts. Must be on the same line.- See Also:
-
ANCHOR_END
The beginning and the end of the anchor texts. Must be on the same line.- See Also:
-
DOCUMENT_END
End of document.- See Also:
-
-
Constructor Details
-
Include
public Include()Constructs an@include
taglet.
-
-
Method Details