public class IncludeTaglet extends AbstractInlineTaglet
{@nx.include} Include raw content from another taglet in a different source file.
Example that includes the XMLUsageTaglet
usage example:
<xml> <sample attr="whatever">Next line should be replaced.</sample> {@nx.include com.norconex.commons.lang.javadoc.XMLUsageTaglet@nx.xml.usage} </xml>
Results in:
<xml>
<sub
attr="whatever">
Next line should be replaced.
</sub>
<test>
<sub
attr="whatever">
Example XML from XMLExampleTaglet.
</sub>
</test>
</xml>
Can be nested in nx.xml.* taglets.
Can also use # if the target defines such as id.
Constructor and Description |
---|
IncludeTaglet() |
Modifier and Type | Method and Description |
---|---|
protected static String |
getJavaSource(String className) |
String |
getName() |
protected Path |
getSourceDir() |
static String |
include(String includeRef) |
static void |
register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
Register an instance of this taglet.
|
String |
toString(com.sun.javadoc.Tag tag) |
inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, resolveIncludes, toString, toString
public static final String NAME
public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
tagletMap
- registry of tagletspublic String getName()
protected Path getSourceDir()
public String toString(com.sun.javadoc.Tag tag)
toString
in interface com.sun.tools.doclets.Taglet
toString
in class AbstractInlineTaglet
Copyright © 2008–2023 Norconex Inc.. All rights reserved.