de.h2b.taglets
Class InlineTaglet

java.lang.Object
  extended by de.h2b.taglets.InlineTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet
Direct Known Subclasses:
CiteTaglet, LabelTaglet, MathTaglet, RefTaglet

@ClassLabel(copyright="Copyright (C) 2008 Hans-Hermann Bode",
            ident="$Id: InlineTaglet.java,v 1.4 2008/12/14 17:05:37 h2b Exp $")
public abstract class InlineTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

An abstract class that represents a Javadoc inline taglet. It implements all in... methods of Taglet so that it can be used in documentation for all program elements.

Since:
h2taglets 0.1
Version:
$Revision: 1.4 $, $Date: 2008/12/14 17:05:37 $
Author:
h2b

Constructor Summary
InlineTaglet()
           
 
Method Summary
abstract  java.lang.String getName()
          Returns the name of this custom tag.
 boolean inConstructor()
          Will return false since it is an inline tag.
 boolean inField()
          Will return false since it is an inline tag.
 boolean inMethod()
          Will return false since it is an inline tag.
 boolean inOverview()
          Will return false since it is an inline tag.
 boolean inPackage()
          Will return false since it is an inline tag.
 boolean inType()
          Will return false since it is an inline tag.
 boolean isInlineTag()
          Will return true since it is an inline tag.
abstract  java.lang.String toString(com.sun.javadoc.Tag tag)
          Given the Tag representation of this custom tag, return its string representation.
 java.lang.String toString(com.sun.javadoc.Tag[] tags)
          This method should not be called since arrays of inline tags do not exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InlineTaglet

public InlineTaglet()
Method Detail

getName

public abstract java.lang.String getName()
Returns the name of this custom tag.

Specified by:
getName in interface com.sun.tools.doclets.Taglet
Returns:
taglet's name
Since:
h2taglets 0.1

inField

public boolean inField()
Will return false since it is an inline tag.

Specified by:
inField in interface com.sun.tools.doclets.Taglet
Returns:
false
Since:
h2taglets 0.1

inConstructor

public boolean inConstructor()
Will return false since it is an inline tag.

Specified by:
inConstructor in interface com.sun.tools.doclets.Taglet
Returns:
false
Since:
h2taglets 0.1

inMethod

public boolean inMethod()
Will return false since it is an inline tag.

Specified by:
inMethod in interface com.sun.tools.doclets.Taglet
Returns:
false
Since:
h2taglets 0.1

inOverview

public boolean inOverview()
Will return false since it is an inline tag.

Specified by:
inOverview in interface com.sun.tools.doclets.Taglet
Returns:
false
Since:
h2taglets 0.1

inPackage

public boolean inPackage()
Will return false since it is an inline tag.

Specified by:
inPackage in interface com.sun.tools.doclets.Taglet
Returns:
false
Since:
h2taglets 0.1

inType

public boolean inType()
Will return false since it is an inline tag.

Specified by:
inType in interface com.sun.tools.doclets.Taglet
Returns:
false
Since:
h2taglets 0.1

isInlineTag

public boolean isInlineTag()
Will return true since it is an inline tag.

Specified by:
isInlineTag in interface com.sun.tools.doclets.Taglet
Returns:
true
Since:
h2taglets 0.1

toString

public abstract java.lang.String toString(com.sun.javadoc.Tag tag)
Given the Tag representation of this custom tag, return its string representation.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Parameters:
tag - the Tag representation of this custom tag
Since:
h2taglets 0.1

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)
This method should not be called since arrays of inline tags do not exist. Method toString(Tag) should be used to convert this inline tag to a string.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Parameters:
tags - the array of Tags representing this custom tag
Since:
h2taglets 0.1


Copyright © 2008 Hans-Hermann Bode, Berlin, Germany. All Rights Reserved.