Package ball.tools.javadoc

Class LinkManTaglet

java.lang.Object

ball.annotation.processing.JavaxLangModelUtilities

ball.tools.javadoc.AbstractTaglet

ball.tools.javadoc.AbstractInlineTaglet

ball.tools.javadoc.LinkManTaglet

All Implemented Interfaces:

AnnotatedTaglet, JavadocHTMLTemplates, PatternMatcherBean, HTMLTemplates, XalanConstants, XMLConstants, XMLServices, Taglet

@TagletName("link.man")
@ServiceProviderFor(jdk.javadoc.doclet.Taglet.class)
@PatternRegex("(?is)(?<name>.+)[(](?<section>[\\p{Alnum}]+)[)]")
public class LinkManTaglet
extends AbstractInlineTaglet
implements PatternMatcherBean

Inline Taglet providing links to man(1) pages.

Author:

Allen D. Ball

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet

Taglet.Location

Field Summary

Fields inherited from class ball.tools.javadoc.AbstractTaglet

trees

Fields inherited from class ball.annotation.processing.JavaxLangModelUtilities

elements, fm, types

Fields inherited from interface ball.xml.XalanConstants

XALAN_INDENT_AMOUNT

Fields inherited from interface ball.xml.XMLConstants

NO, YES

Constructor Summary

Constructors

Constructor	Description
LinkManTaglet()

Method Summary

Modifier and Type	Method	Description
protected void	setName(String string)
protected void	setSection(String string)
FluentNode	toNode(UnknownInlineTagTree tag, Element context)	Abstract method to be overridden by subclass implementations.

Methods inherited from class ball.tools.javadoc.AbstractInlineTaglet

isInlineTag, toNode

Methods inherited from class ball.tools.javadoc.AbstractTaglet

a, a, a, a, document, getBeanInfo, getBeanInfo, getClassLoader, getResourcePathOf, getResourceURLOf, getText, href, init, print, print, render, render, toString

Methods inherited from class ball.annotation.processing.JavaxLangModelUtilities

asClass, asExecutableElement, asExecutableElement, asPackageInfoClass, asTypeElement, asTypeMirror, asTypeMirrorList, asVariableElement, getAnnotationMirror, getAnnotationMirror, getAnnotationValue, getClassPathClassLoader, getClassPathClassLoader, getConstructor, getEnclosingTypeElement, getMethod, getPropertyName, getPropertyNames, getTypeElementFor, hasSameSignatureAs, hasSameSignatureAs, hasSameSignatureAs, implementationOf, isAssignableTo, isAssignableTo, isAssignableTo, isAssignableTo, isEmptyArray, isGenerated, isGetterMethod, named, overrides, overrides, signature, signature, specifiedBy, toEnumSet, toModifiers, toString, with, withModifiers, withModifiers, without, withoutModifiers, withoutModifiers, withParameters, withParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ball.tools.javadoc.AnnotatedTaglet

getAllowedLocations, getName

Methods inherited from interface ball.xml.HTMLTemplates

a, a, a, b, b, caption, code, code, div, div, h1, h1, h1, h2, h2, h2, h3, h3, h3, h4, h4, h4, h5, h5, h5, h6, h6, h6, li, li, li, ol, ol, p, p, p, pre, pre, table, table, tbody, tbody, td, td, tfoot, tfoot, th, th, thead, thead, tr, tr, u, u, ul, ul

Methods inherited from interface ball.tools.javadoc.JavadocHTMLTemplates

a, a, a, a, a, a, annotation, declaration, declaration, declaration, declaration, declaration, modifiers, modifiers, table, table, toHTML, type, type, type, type

Methods inherited from interface ball.util.PatternMatcherBean

initialize, matcher, pattern

Methods inherited from interface ball.xml.XMLServices

asStream, attr, attr, cdata, comment, element, element, fragment, fragment, text

Constructor Detail

LinkManTaglet

public LinkManTaglet()

Method Detail

setName

@MatcherGroup(1)
protected void setName(String string)

setSection

@MatcherGroup(2)
protected void setSection(String string)

toNode

public FluentNode toNode(UnknownInlineTagTree tag,
                         Element context)
                  throws Throwable

Description copied from class: AbstractInlineTaglet

Abstract method to be overridden by subclass implementations.

Specified by:

toNode in class AbstractInlineTaglet

Parameters:

tag - The instance of this tag.

context - The element to which the enclosing comment belongs.

Returns:

The Node representing the output.

Throws:

Throwable - As required by the subclass.