org.freehep.tools.doclet.tags
Class InheritDocTaglet

java.lang.Object
  org.freehep.tools.doclet.tags.AbstractInlineTaglet
      org.freehep.tools.doclet.tags.InheritDocTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class InheritDocTaglet

extends AbstractInlineTaglet

An inline Taglet representing {@inheritDoc}. This tag should only be used with a method. It is used to inherit documentation from overriden and implemented methods.

Since:

1.4

Author:

Jamie Ho

Source Code:

InheritDocTaglet.java

Field Summary

Fields inherited from class org.freehep.tools.doclet.tags.AbstractInlineTaglet

name

Constructor Summary

InheritDocTaglet()
Construct a new InheritDocTaglet.

Method Summary

String

toString(com.sun.javadoc.Tag tag, com.sun.javadoc.Doc doc, HtmlStandardWriter writer) Given the Tag representation of this custom tag, return its string representation.

Methods inherited from class org.freehep.tools.doclet.tags.AbstractInlineTaglet

getName, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InheritDocTaglet

public InheritDocTaglet()

Construct a new InheritDocTaglet.

Method Detail

toString

public String toString(com.sun.javadoc.Tag tag,
                       com.sun.javadoc.Doc doc,
                       HtmlStandardWriter writer)

Given the Tag representation of this custom tag, return its string representation.

Specified by:

toString in class AbstractInlineTaglet

Parameters:

tag - he Tag representation of this custom tag.

doc - the field that holds this tag.

writer - the HtmlStandardWriter used to write this inline tag.