|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.acm.seguin.pretty.JavadocDescriptionPrinter
public class JavadocDescriptionPrinter
Prints a description from a java doc comment with HTML tags formatted.
Constructor Summary | |
---|---|
JavadocDescriptionPrinter(PrintData data,
java.lang.String description)
Constructor for the JavadocDescriptionPrinter object |
|
JavadocDescriptionPrinter(PrintData data,
java.lang.String description,
int initIndent)
Constructor for the JavadocDescriptionPrinter object |
Method Summary | |
---|---|
protected boolean |
endMode(net.sourceforge.jrefactory.parser.Token forToken)
Detects the end of the tag marker |
protected void |
indent()
Indents the line and inserts the required "*" |
void |
run()
This is the main program. |
static boolean |
spaceRequired(java.lang.String token)
Certain tags require that we insert a space after them. |
protected boolean |
spaceRequired(net.sourceforge.jrefactory.parser.Token token)
Certain tags require that we insert a space after them. |
protected boolean |
startMode(net.sourceforge.jrefactory.parser.Token forToken)
Certain tags require that we insert a new line after them. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavadocDescriptionPrinter(PrintData data, java.lang.String description)
data
- Description of Parameterdescription
- Description of Parameterpublic JavadocDescriptionPrinter(PrintData data, java.lang.String description, int initIndent)
data
- Description of Parameterdescription
- Description of ParameterinitIndent
- Description of ParameterMethod Detail |
---|
public void run()
protected void indent()
protected boolean startMode(net.sourceforge.jrefactory.parser.Token forToken)
forToken
- the tag that we are considering
protected boolean spaceRequired(net.sourceforge.jrefactory.parser.Token token)
token
- the tag that we are considering
protected boolean endMode(net.sourceforge.jrefactory.parser.Token forToken)
forToken
- the token
true
if a newline has been issued.public static boolean spaceRequired(java.lang.String token)
token
- the tag that we are considering (should be upper case).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |