nesstar.javadoc
Class NoteTaglet

java.lang.Object
  extended by nesstar.javadoc.ATaglet
      extended by nesstar.javadoc.NoteTaglet

public class NoteTaglet
extends ATaglet

A Taglet for @note. This is an inline tag used for notes. The text is displayed in light grey.

Author:
Titto Assini

Constructor Summary
NoteTaglet()
           
 
Method Summary
 String getName()
          Return the name of this custom tag.
static void register(Map tagletMap)
          Register this Taglet.
 String toString(Tag[] tags)
          Given an array of Tags representing this custom tag, return its string representation.
 
Methods inherited from class nesstar.javadoc.ATaglet
inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, register
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NoteTaglet

public NoteTaglet()
Method Detail

register

public static void register(Map tagletMap)
Register this Taglet.

Parameters:
tagletMap - the map to register this tag to.

getName

public String getName()
Return the name of this custom tag.


toString

public String toString(Tag[] tags)
Given an array of Tags representing this custom tag, return its string representation.

Overrides:
toString in class ATaglet
Parameters:
tags - the array of Tags representing of this custom tag.

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved