| java.lang.Object
 org.acm.seguin.pretty.JavaDocableImpl
| JavaDocableImpl | | public class JavaDocableImpl implements JavaDocable(Code) | | Stores the java doc components
author:
Chris Seguin
author:
Mike Atkinson |
| JavaDocableImpl | | public JavaDocableImpl()(Code) | | Constructor
|
| addJavaDocComponent | | public void addJavaDocComponent(JavaDocComponent component)(Code) | | Allows you to add a java doc component
Parameters:
component - the component that can be added |
| contains | | public boolean contains(String type)(Code) | | Contains a particular item
Parameters:
type - the type we are looking for true if we found a tag with that name |
| contains | | public boolean contains(String type, String id)(Code) | | Contains a particular item
Parameters:
type - the type we are looking for
Parameters:
id - the id Description of the Returned Value |
| finish | | public void finish()(Code) | | Makes sure all the java doc components are present
|
| isPrinted | | public boolean isPrinted()(Code) | | Determines if the javadoc comments were printed
The Printed value |
| isRequired | | public boolean isRequired()(Code) | | Checks to see if it was printed
true if it still needs to be printed |
| printJavaDocComponents | | public void printJavaDocComponents(PrintData printData)(Code) | | Prints all the java doc components
Parameters:
printData - the print data |
| printJavaDocComponents | | public void printJavaDocComponents(PrintData printData, String order)(Code) | | Prints all the java doc components
Parameters:
printData - the print data
Parameters:
order - the order for the tags |
| require | | public void require(String tag, String descr)(Code) | | Make a required field
Parameters:
tag - the tag
Parameters:
descr - the default description |
| require | | public void require(String tag, String id, String descr)(Code) | | Make a required field
Parameters:
tag - the tag
Parameters:
id - the id
Parameters:
descr - the default description |
| sort | | public void sort(String type, String[] names)(Code) | | Allows you to sort the javadoc tags.
Parameters:
type - The "@"tag to sort (e.g. "@param").
Parameters:
names - The order of identifies desired after sort (e.g. for this method {"type", "names"} ).
since:
JRefactory 2.7.00 |
|
|