public class DocAttribute extends SingletonAttribute
NamedObj.ContainedObjectsIterator
Modifier and Type | Field and Description |
---|---|
StringAttribute |
author
The author field.
|
StringAttribute |
description
The description.
|
StringAttribute |
since
The since field.
|
StringAttribute |
version
The version field.
|
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
Constructor and Description |
---|
DocAttribute()
Construct an empty DocAttribute.
|
DocAttribute(NamedObj container,
java.lang.String name)
Construct a documentation attribute with the given name contained
by the specified entity.
|
DocAttribute(Workspace workspace)
Construct a DocAttribute in a given workspace.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getParameterDoc(java.lang.String name)
Return the documentation for the given parameter, or null if there
none.
|
java.lang.String |
getPortDoc(java.lang.String name)
Return the documentation for the given port, or null if there
none.
|
void |
refreshParametersAndPorts()
For each parameter and port in the container, create a
parameter with the same name appended with either " (port)",
" (port-parameter)",
or " (parameter)".
|
setContainer
_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, 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 StringAttribute author
public StringAttribute description
public StringAttribute since
public StringAttribute version
public DocAttribute(NamedObj container, java.lang.String name) throws IllegalActionException, NameDuplicationException
container
- The container.name
- The name of this attribute.IllegalActionException
- If the attribute is not of an
acceptable class for the container, or if the name contains a period.NameDuplicationException
- If the name coincides with
an attribute already in the container.public DocAttribute()
public DocAttribute(Workspace workspace)
workspace
- The workspace in which to construct the DocAttribute.public java.lang.String getParameterDoc(java.lang.String name)
name
- The name of the parameter.public java.lang.String getPortDoc(java.lang.String name)
name
- The name of the port.public void refreshParametersAndPorts()