org.docgene.model

Class XMLAPIDocElement

java.lang.Object

org.docgene.model.AbstractXMLAPIDoc

org.docgene.model.XMLAPIDocElement

All Implemented Interfaces:

org.docgene.model.globals.apidocs.APIDocTypes, ParagraphElement, ParagraphElementParent, StyledElement

public class XMLAPIDocElement
extends AbstractXMLAPIDoc

/** * Represent the content of an <element> tag under an <apidoc>.

Since:

1.4.17

Field Summary

Fields inherited from class org.docgene.model.AbstractXMLAPIDoc

api, element, modifiers, path

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.globals.apidocs.APIDocTypes

ELEMENT_ARGUMENT, ELEMENT_CLASS, ELEMENT_CONSTANT, ELEMENT_CONSTRUCTOR, ELEMENT_DESTRUCTOR, ELEMENT_ENUM, ELEMENT_EVENT, ELEMENT_FIELD, ELEMENT_FUNCTION, ELEMENT_GETTER, ELEMENT_HEADER, ELEMENT_INTERFACE, ELEMENT_MACRO, ELEMENT_METHOD, ELEMENT_MODULE, ELEMENT_OPERATOR, ELEMENT_PROPERTY, ELEMENT_RETURN, ELEMENT_SETTER, ELEMENT_SOURCE, ELEMENT_STRUCT, ELEMENT_TYPEDEF, TYPE_CSHARP, TYPE_DOXYGEN, TYPE_JAVA, TYPE_PYTHON, TYPE_QT, UNDEF

Constructor Summary

Constructors

Constructor and Description
XMLAPIDocElement(org.docgene.model.globals.apidocs.APIDoc.Element element) Create an APIDoc element.
XMLAPIDocElement(org.docgene.model.globals.apidocs.APIDoc.Element element, AbstractXMLAPIDoc parent) Create an APIDoc element.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.lang.String	getModifiers() Return the modifiers.
AbstractXMLAPIDoc	getParent() Return the parent element.
boolean	hasParent() Return true if this element has a parent.

Methods inherited from class org.docgene.model.AbstractXMLAPIDoc

addElement, countDocElements, getAPI, getAPIID, getCustomStyles, getDocElements, getDocElementsAsList, getDocElementsList, getElements, getElementSpecification, getElementTypeName, getName, getParentType, getPath, getType, hasDocElement, setCustomStyles, setElements, setModifiers, setPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.globals.apidocs.APIDocTypes

getElementType, getParentType, pathRequired

Constructor Detail

XMLAPIDocElement

public XMLAPIDocElement(org.docgene.model.globals.apidocs.APIDoc.Element element,
                        AbstractXMLAPIDoc parent)

Create an APIDoc element.

Parameters:

element - the element specification

parent - the parent apidoc

XMLAPIDocElement

public XMLAPIDocElement(org.docgene.model.globals.apidocs.APIDoc.Element element)

Create an APIDoc element.

Parameters:

element - the element specification

Method Detail

getParent

public AbstractXMLAPIDoc getParent()

Return the parent element.

Returns:

the parent

hasParent

public boolean hasParent()

Return true if this element has a parent.

Returns:

true if this element has a parent

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Returns:

the declaration ID of the element

getModifiers

public java.lang.String getModifiers()

Return the modifiers.

Specified by:

getModifiers in class AbstractXMLAPIDoc

Returns:

the modifiers