FreeHEP API
Version current

org.freehep.tools.doclet.tags
Class ValueTaglet

java.lang.Object
  extended byorg.freehep.tools.doclet.tags.AbstractInlineTaglet
      extended byorg.freehep.tools.doclet.tags.ValueTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class ValueTaglet
extends AbstractInlineTaglet

An inline Taglet representing {@value}. This tag should only be used with constant fields that have a value. It is used to access the value of constant fields.

Since:
1.4
Author:
Jamie Ho
Source Code:
ValueTaglet.java

Field Summary
 
Fields inherited from class org.freehep.tools.doclet.tags.AbstractInlineTaglet
name
 
Constructor Summary
ValueTaglet()
          Construct a new ValueTaglet.
 
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

ValueTaglet

public ValueTaglet()
Construct a new ValueTaglet.

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.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.