public class DocBuilder extends Attribute
This class sets the commands that build the Java classes.
NamedObj.ContainedObjectsIterator
Modifier and Type | Field and Description |
---|---|
Parameter |
cleanFirst
If true, then clean before building documentation.
|
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
Constructor and Description |
---|
DocBuilder(NamedObj container,
java.lang.String name)
Create a new instance of the DocBuilder.
|
Modifier and Type | Method and Description |
---|---|
int |
buildDocs()
Build the Java class and Actor documentation.
|
ExecuteCommands |
getExecuteCommands()
Get the command executor, which can be either non-graphical
or graphical.
|
void |
setConfiguration(Configuration configuration)
Set the configuration.
|
void |
setExecuteCommands(ExecuteCommands executeCommands)
Set the command executor, which can be either non-graphical
or graphical.
|
_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, updateContent
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace
public Parameter cleanFirst
public DocBuilder(NamedObj container, java.lang.String name) throws IllegalActionException, NameDuplicationException
container
- The container.name
- The name of the code generator.IllegalActionException
- If the super class throws the
exception or error occurs when setting the file path.NameDuplicationException
- If the super class throws the
exception or an error occurs when setting the file path.public int buildDocs() throws IllegalActionException
$PTII/doc
.
However, if the configuration set by setConfiguration(Configuration)
then the configuration is
searched for a _docApplicationSpecializer parameter. If that
parameter exists it is assumed to name a class that implements
the DocApplicationSpecializer
interface and the
DocApplicationSpecializer.buildCommands(ExecuteCommands)
method which returns the commands to invoke.IllegalActionException
- If there is a problem building
the documentation.public ExecuteCommands getExecuteCommands()
setExecuteCommands(ExecuteCommands)
public void setConfiguration(Configuration configuration)
configuration
- The configuration in which we look up the
_applicationName and _docApplicationSpecializer parameters.public void setExecuteCommands(ExecuteCommands executeCommands)
executeCommands
- The subprocess command executor.getExecuteCommands()