| java.lang.Object org.acm.seguin.pretty.JavadocDescriptionPrinter
JavadocDescriptionPrinter | public class JavadocDescriptionPrinter (Code) | | Prints a description from a java doc comment with HTML tags formatted.
author: Chris Seguin author: Mike Atkinson |
Method Summary | |
protected boolean | endMode(Token forToken) | protected void | indent() | public void | run() This is the main program. | protected boolean | spaceRequired(Token token) Certain tags require that we insert a space after them. | public static boolean | spaceRequired(String token) Certain tags require that we insert a space after them.
Parameters: token - the tag that we are considering (should be upper case). | protected boolean | startMode(Token forToken) Certain tags require that we insert a new line after them. |
JavadocDescriptionPrinter | public JavadocDescriptionPrinter(PrintData data, String description)(Code) | | Constructor for the JavadocDescriptionPrinter object
Parameters: data - Description of Parameter Parameters: description - Description of Parameter |
JavadocDescriptionPrinter | public JavadocDescriptionPrinter(PrintData data, String description, int initIndent)(Code) | | Constructor for the JavadocDescriptionPrinter object
Parameters: data - Description of Parameter Parameters: description - Description of Parameter Parameters: initIndent - Description of Parameter |
endMode | protected boolean endMode(Token forToken)(Code) | | Detects the end of the tag marker
Parameters: forToken - the token true if a newline has been issued. |
indent | protected void indent()(Code) | | Indents the line and inserts the required "*"
|
run | public void run()(Code) | | This is the main program.
|
spaceRequired | protected boolean spaceRequired(Token token)(Code) | | Certain tags require that we insert a space after them.
Parameters: token - the tag that we are considering true if we just printed a space or a newline since: JRefactory 2.7.00 |
spaceRequired | public static boolean spaceRequired(String token)(Code) | | Certain tags require that we insert a space after them.
Parameters: token - the tag that we are considering (should be upper case). true if we just printed a space or a newline since: JRefactory 2.9.17 |
startMode | protected boolean startMode(Token forToken)(Code) | | Certain tags require that we insert a new line after them.
Parameters: forToken - the tag that we are considering true if we just printed a space or a newline |
|
|