org.docgene.model

Class XMLAPIDoc

java.lang.Object

org.docgene.model.AbstractXMLAPIDoc

org.docgene.model.XMLAPIDoc

All Implemented Interfaces:

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

public class XMLAPIDoc
extends AbstractXMLAPIDoc

Represent the content of an <apidoc> tag.

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
XMLAPIDoc(org.docgene.model.globals.apidocs.APIDoc.Element element) 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.
boolean	hasThematicBreak() Return true if the api has thematic breaks("hr").
boolean	isCompact() Return true if the api should have a compact representation.
void	setCompact(boolean isCompact) Set if the api should have a compact representation.
void	setThematicBreak(boolean hasHR) Set if the api has thematic breaks("hr").

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

XMLAPIDoc

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

Create an APIDoc element.

Parameters:

element - the element specification

Method Detail

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

setThematicBreak

public void setThematicBreak(boolean hasHR)

Set if the api has thematic breaks("hr").

Parameters:

hasHR - true if the api has thematic breaks("hr")

hasThematicBreak

public boolean hasThematicBreak()

Return true if the api has thematic breaks("hr").

Returns:

true if the api has thematic breaks("hr")

setCompact

public void setCompact(boolean isCompact)

Set if the api should have a compact representation.

Parameters:

isCompact - true if the api should have a compact representation

isCompact

public boolean isCompact()

Return true if the api should have a compact representation.

Returns:

if the api should have a compact representation