Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> halesoft >> [ jcomment overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.halesoft.jcomment
Class JavaDocTag  

java.lang.Object
  com.halesoft.jcomment.JavaDocTag

Direct Known Subclasses:

JavaDocTag.Param, JavaDocTag.See, JavaDocTag.SerialField, JavaDocTag.Throws

---

public final class JavaDocTag

extends java.lang.Object

Represents a documentation tag such as:

    author
    deprecated
    exception
    param
    return
    see
    serial
    serialData
    serialField
    since
    throws
    version
 

Given a tag, holds tag and tag text. Tags with structure or which require special processing are handled by special interfaces (JavaDocTag.See, JavaDocTag.Param, JavaDocTag.Throws, and JavaDocTag.SerialField).

The interfaces provide subset of methods defined in Tag interfaces in the Doclet API.

This implementation holds informations about tags in memory.

Version:

1.0

---

Nested Class Summary
static class	JavaDocTag.Param           Represents a param documentation tag.
static class	JavaDocTag.See           Represents a see documentation tag.
static class	JavaDocTag.SerialField           Represents an serialField documentation tag defined by an ObjectStreamField.
static class	JavaDocTag.Throws           Represents a throws or an exception documentation tag.

 

Field Summary
private  java.lang.String	name_           Tag name storage.
private  java.lang.String	text_           Tag type storage

 

Constructor Summary

JavaDocTag(java.lang.String name, java.lang.String text)           Creates a JavaDocTag object with a name and text beyond the tag name.

 

Method Summary
protected  java.lang.String[]	divideAtWhite()           Partitions tags that have two parts of tag text.
java.lang.String	getKind()           Returns the kind of this tag.
java.lang.String	getName()           Returns the name of this tag.
java.lang.String	getText()           Returns the text of this tag.
protected  void	printWarning(java.lang.String s1, java.lang.String s2)           Prints warning message to the console.
java.lang.String	toString()           Returns a fully formed tag.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

name_

private java.lang.String name_

Tag name storage.

---

text_

private java.lang.String text_

Tag type storage

Constructor Detail

JavaDocTag

public JavaDocTag(java.lang.String name,
                  java.lang.String text)

Creates a JavaDocTag object with a name and text beyond the tag name.

Method Detail

toString

public java.lang.String toString()

Returns a fully formed tag.

---

getName

public java.lang.String getName()

Returns the name of this tag.

---

getKind

public java.lang.String getKind()

Returns the kind of this tag.

---

getText

public java.lang.String getText()

Returns the text of this tag.

---

divideAtWhite

protected java.lang.String[] divideAtWhite()

Partitions tags that have two parts of tag text. Used by subclasses of this class.

---

printWarning

protected void printWarning(java.lang.String s1,
                            java.lang.String s2)

Prints warning message to the console.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> halesoft >> [ jcomment overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---