de.h2b.taglets
Class BlockTaglet

java.lang.Object
  extended by de.h2b.taglets.BlockTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet
Direct Known Subclasses:
BiblioTaglet

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

An abstract class that represents a Javadoc block 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.3 $, $Date: 2008/12/14 17:05:37 $
Author:
h2b

Constructor Summary
BlockTaglet()
           
 
Method Summary
abstract  java.lang.String getName()
          Returns the name of this custom tag.
 boolean inConstructor()
          Will return true since it can be used in constructor documentation.
 boolean inField()
          Will return true since it can be used in field documentation.
 boolean inMethod()
          Will return true since it can be used in method documentation.
 boolean inOverview()
          Will return true since it can be used in overview documentation.
 boolean inPackage()
          Will return true since it can be used in package documentation.
 boolean inType()
          Will return true since it can be used in type documentation (classes or interfaces).
 boolean isInlineTag()
          Will return false since it is not 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.
abstract  java.lang.String toString(com.sun.javadoc.Tag[] tags)
          Given an array of Tags representing this custom tag, return its string representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BlockTaglet

public BlockTaglet()
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 true since it can be used in field documentation.

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

inConstructor

public boolean inConstructor()
Will return true since it can be used in constructor documentation.

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

inMethod

public boolean inMethod()
Will return true since it can be used in method documentation.

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

inOverview

public boolean inOverview()
Will return true since it can be used in overview documentation.

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

inPackage

public boolean inPackage()
Will return true since it can be used in package documentation.

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

inType

public boolean inType()
Will return true since it can be used in type documentation (classes or interfaces).

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

isInlineTag

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

Specified by:
isInlineTag in interface com.sun.tools.doclets.Taglet
Returns:
false
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 abstract java.lang.String toString(com.sun.javadoc.Tag[] tags)
Given an array of Tags representing this custom tag, return its string representation.

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


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