org.sandev.generator.tags
Class GeneralTagHelp

java.lang.Object
  org.sandev.generator.tags.AbstractSandBaseTag
      org.sandev.generator.tags.AbstractSandGeneralTag
          org.sandev.generator.tags.GeneralTagHelp

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class GeneralTagHelp
extends AbstractSandGeneralTag

Handle @sand.help declarations. Declares help text to be displayed for a field or class. This text is used to generate a helpfile for the application, and interactive help for the fields. Can be used at either the field or class level. Typical use:

• Non-localized system: Provides a quick and easy help implementation
• Localized system options:
  1. Use a keyword rather than raw text and then look that up in the appropriate resource as needed.
  2. Maintain a separate build for each locale other than the primary, copying over everything except structs and templates which have their own localized copies.
  Which is easier depends on how many translations you are maintaining.

parameters:

1. The print value name

Field Summary

static java.lang.String	CORENAME The core name of this tag.
protected java.lang.String	description The descriptive help text.
static java.lang.String	TAGNAME Our fixed name, used for hash lookup and text parsing.

Fields inherited from class org.sandev.generator.tags.AbstractSandBaseTag

PREFIX

Constructor Summary

GeneralTagHelp()

Method Summary

static boolean	exists(com.sun.javadoc.ProgramElementDoc ped) Returns true if the given program element contains this tag, false otherwise.
java.lang.String	getDescription() accessor for description
static GeneralTagHelp	getGeneralTagHelp(com.sun.javadoc.ProgramElementDoc ped) Factory method for retrieving a new instance given a program element doc object.
java.lang.String	getName() Return our tag name
java.lang.String	getTipText() Returns the first sentence or line of text from the description.
void	init(com.sun.javadoc.Tag tag) Initialize this instance from the tag information.
static void	register(java.util.Map tagletMap) Registers this taglet when triggered by the taglet declaration being loaded in as part of the build.
void	setDescription(java.lang.String val) mutator for description
java.lang.String	toString(com.sun.javadoc.Tag tag) Return a documentation description of this tag.
java.lang.String	toString(com.sun.javadoc.Tag[] tags) Return the documentation text for when several of these tags are present

Methods inherited from class org.sandev.generator.tags.AbstractSandGeneralTag

inField, inType

Methods inherited from class org.sandev.generator.tags.AbstractSandBaseTag

inConstructor, inMethod, inOverview, inPackage, isInlineTag, registerHelper

Methods inherited from class java.lang.Object

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

Field Detail

CORENAME

public static final java.lang.String CORENAME

The core name of this tag.

See Also:

Constant Field Values

description

protected java.lang.String description

The descriptive help text.

TAGNAME

public static final java.lang.String TAGNAME

Our fixed name, used for hash lookup and text parsing.

See Also:

Constant Field Values

Constructor Detail

GeneralTagHelp

public GeneralTagHelp()

Method Detail

getDescription

public java.lang.String getDescription()

accessor for description

setDescription

public void setDescription(java.lang.String val)

mutator for description

init

public void init(com.sun.javadoc.Tag tag)

Initialize this instance from the tag information.

getTipText

public java.lang.String getTipText()

Returns the first sentence or line of text from the description. If no description, then this returns the empty string.

getName

public java.lang.String getName()

Return our tag name

register

public static void register(java.util.Map tagletMap)

Registers this taglet when triggered by the taglet declaration being loaded in as part of the build.

toString

public java.lang.String toString(com.sun.javadoc.Tag tag)

Return a documentation description of this tag.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Specified by:

toString in class AbstractSandBaseTag

Parameters:

tag - the Tag representation of this custom tag.

toString

public java.lang.String toString(com.sun.javadoc.Tag[] tags)

Return the documentation text for when several of these tags are present

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Specified by:

toString in class AbstractSandBaseTag

Parameters:

tags - the array of Tags representing of this custom tag.

getGeneralTagHelp

public static GeneralTagHelp getGeneralTagHelp(com.sun.javadoc.ProgramElementDoc ped)

Factory method for retrieving a new instance given a program element doc object. Returns an initialized instance of the tag.

exists

public static boolean exists(com.sun.javadoc.ProgramElementDoc ped)

Returns true if the given program element contains this tag, false otherwise.