| Package | Description | 
|---|---|
| org.docgene.model | Contains the documentation model. | 
| org.docgene.model.globals | Contains the global elements for the wiki model. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ArticleReferenceAn article reference. | 
| interface  | EmptyElementA tagging interface for break and empty line elements. | 
| interface  | ExternalLinkRepresent an external link, which can be a bare link or a link to a class in a Java API. | 
| interface  | HTMLRootElementRepresent an HTML included content. | 
| interface  | ListElementRepresent any element which can be included in a list. | 
| interface  | ParagraphArticleReferenceAn article reference in a paragraph. | 
| interface  | SpanTextElement | 
| interface  | StylableTextA text which may have a decoration. | 
| interface  | TreeElementRepresent any element which can be included in a tree. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | AbstractAPIA general API link. | 
| class  | AbstractJustifiedElementA ParagraphElement which can be justified depending on if it is the first in its line. | 
| class  | AbstractLinkAn abstract Link. | 
| class  | AbstractMoreInfoRefRepresent an "info" or "moreInfo" reference. | 
| class  | AbstractParagraphRepresent the content of a paragraph. | 
| class  | AbstractStylableTextA text which may have a decoration. | 
| class  | AbstractStyledElementAn element with custom styles. | 
| class  | AbstractWikiLinkAn abstract wiki link. | 
| class  | AbstractXMLAPIDocA general API documentation. | 
| class  | XMLAnchorRepresent an anchor in an article. | 
| class  | XMLAPIDocRepresent the content of an <apidoc> tag. | 
| class  | XMLAPIDocElement/**
  * Represent the content of an <element> tag under an <apidoc>. | 
| class  | XMLArchiveURLRepresent an external link (to a web page or a local file). | 
| class  | XMLAudioRepresent an link to an embedded audio. | 
| class  | XMLBasicNoteRepresent the content of a "note" element. | 
| class  | XMLBlockRepresent the content of a block tag. | 
| class  | XMLBlockquoteRepresent the content of a blockquote tag. | 
| class  | XMLBoxRepresent the content of a <box> tag. | 
| class  | XMLBreakRepresent the content of a <br> tag. | 
| class  | XMLCategoryReferenceRepresent an internal reference to a category description. | 
| class  | XMLChapterRepresents a chapter. | 
| class  | XMLCitationRepresent the content of a "cite" element. | 
| class  | XMLCodeRepresent the content of a <code> tag. | 
| class  | XMLCommentRepresent the content of a <comment> tag. | 
| class  | XMLCommentListRepresent the content of a <commentlist> tag. | 
| class  | XMLConditionRepresents a condition. | 
| class  | XMLDateRepresent the content of a <date> tag. | 
| class  | XMLDivRepresent a container of sentences. | 
| class  | XMLDotNetAPIRepresent an link to a .NET API. | 
| class  | XMLDoxygenAPIRepresent an link to a Doxygen API. | 
| class  | XMLEmptyLineRepresent the content of an <empty> tag. | 
| class  | XMLExtendedImageRepresent the reference to an image which has a link to an areaRef, a ref, or a link. | 
| class  | XMLExternalLinkRepresent an external link (to a web page or a local file). | 
| class  | XMLGlossaryReferenceRepresent an internal reference to the glossary. | 
| class  | XMLHRRepresent the content of a <hr> tag (a thematic break). | 
| class  | XMLHTMLElementThe element for html embedded content. | 
| class  | XMLIfConditionRepresent the content of a if or else condition. | 
| class  | XMLImageRepresent the reference to an image. | 
| class  | XMLIncludeRepresent an included internal reference (to another article). | 
| class  | XMLIncludedAPIA general included API link. | 
| class  | XMLIncludedAPIArgumentRepresent an argument in an included API method. | 
| class  | XMLIncludedAPIMemberRepresent an link to an included API <memberégt; tag under a <javaAPI> or <pythonAPI> tag | 
| class  | XMLJavaAPIRepresent a link to a Java API. | 
| class  | XMLListRepresent the content of an <ul> or <ol> tag. | 
| class  | XMLListItemRepresent the content of a <li> tag. | 
| class  | XMLMailLinkRepresent an email link. | 
| class  | XMLMapRepresent the reference to a Map. | 
| class  | XMLMediawikiLinkRepresent a mediawiki link. | 
| class  | XMLMenuA left or right menu. | 
| class  | XMLMessageBoxRepresent the content of a messageBox tag. | 
| class  | XMLMoreInfoRepresent a "moreInfo" reference which is present in a "Main Article" tag. | 
| class  | XMLMoreInfoRefRepresent an "info" ref which is present under a "moreInfo" ref. | 
| class  | XMLNoteRefRepresent the a reference to a note. | 
| class  | XMLParagraphRepresent the content of a paragraph - a <par> tag. | 
| class  | XMLPreRepresent the content of "pre" or "source" tags. | 
| class  | XMLPythonAPIRepresent an link to a python API. | 
| class  | XMLQtAPIRepresent an link to a Qt API. | 
| class  | XMLRedirectRepresents an XML redirect article. | 
| class  | XMLReferenceRepresent an internal reference (to another article). | 
| class  | XMLResourceRepresent an internal link (to any file). | 
| class  | XMLSeeAlsoRepresent an internal reference which is present in a "See Also" chapter. | 
| class  | XMLSeeAlsoHeadingRepresent a "SeeAlso" reference in the article header. | 
| class  | XMLSeeArticleRepresent an internal reference which is present in a "See also" tag in a paragraph. | 
| class  | XMLSentenceRepresent a sentence in a paragraph. | 
| class  | XMLSizedTableRowRepresent a Table Row. | 
| class  | XMLSpanRepresent a sentence in a pre element. | 
| class  | XMLTabRepresent the content of a <tab> tag. | 
| class  | XMLTableRepresent the content of a <table> tag. | 
| class  | XMLTableCellRepresent a Table Cell. | 
| class  | XMLTableColumnRepresent a table column. | 
| class  | XMLTableHeaderRepresent a Table Header. | 
| class  | XMLTableRowRepresent a Table Row. | 
| class  | XMLTermRepresent the content of a <term> tag. | 
| class  | XMLTextStyleRepresents the style of a text. | 
| class  | XMLTitleRepresents a title. | 
| class  | XMLTodoRepresent the content of a <todo> tag. | 
| class  | XMLTodoListRepresent the content of a <todolist> tag. | 
| class  | XMLTreeRepresent the content of an <tree> tag. | 
| class  | XMLTreeItemRepresent the content of a <li> tag in a tree. | 
| class  | XMLVideoRepresent an link to an embedded video. | 
| class  | XMLWikipediaLinkRepresent a Wikipedia link. | 
| class  | XMLWordRepresent a word anchor in an article. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected java.util.List<ParagraphElement> | AbstractParagraph. elementsThe elements children. | 
| Modifier and Type | Method and Description | 
|---|---|
| default ParagraphElement | ParagraphElementParent. getElement(int index)Return the nth of child element. | 
| default ParagraphElement | ParagraphElementParent. getFirstElement()Return the first element of null if there are no children elements. | 
| default ParagraphElement | ParagraphElementParent. getLastElement()Return the last element of null if there are no children elements. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<ParagraphElement> | AbstractParagraph. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | AbstractXMLAPIDoc. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | ParagraphElementParent. getElements()Return the list of children elements. | 
| java.util.List<ParagraphElement> | XMLBox. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLChapter. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLCode. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLIfCondition. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLIncludedAPI. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLIncludedAPIArgument. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLIncludedAPIMember. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLInfobox. getElements() | 
| java.util.List<ParagraphElement> | XMLInfobox.BaseProperty. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLList. getElements()Return the list of children elements. | 
| java.util.List<ParagraphElement> | XMLListItem. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLPre. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLTable. getElements() | 
| java.util.List<ParagraphElement> | XMLTableCell. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLTerm. getElements()Return the list of elements. | 
| java.util.List<ParagraphElement> | XMLTextStyle. getElements()Return the list of children elements. | 
| java.util.List<ParagraphElement> | XMLTree. getElements()Return the list of children elements. | 
| java.util.List<ParagraphElement> | XMLTreeItem. getElements()Return the list of elements. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | AbstractParagraph. addElement(ParagraphElement element)Add an element. | 
| void | AbstractXMLAPIDoc. addElement(ParagraphElement element)Add an element. | 
| void | ParagraphElementParent. addElement(ParagraphElement element)Add an element. | 
| void | XMLBox. addElement(ParagraphElement element)Add an element. | 
| void | XMLChapter. addElement(ParagraphElement element)Add an element. | 
| void | XMLCode. addElement(ParagraphElement element)Add an element. | 
| void | XMLIfCondition. addElement(ParagraphElement element)Add an element. | 
| void | XMLIncludedAPI. addElement(ParagraphElement element)Add an element. | 
| void | XMLIncludedAPIArgument. addElement(ParagraphElement element)Add an element. | 
| void | XMLIncludedAPIMember. addElement(ParagraphElement element)Add an element. | 
| void | XMLInfobox. addElement(ParagraphElement element) | 
| void | XMLInfobox.BaseProperty. addElement(ParagraphElement element)Add an element. | 
| void | XMLList. addElement(ParagraphElement element)Add an element. | 
| void | XMLListItem. addElement(ParagraphElement element)Add an element. | 
| void | XMLPre. addElement(ParagraphElement element)Add an element. | 
| void | XMLTable. addElement(ParagraphElement element) | 
| void | XMLTableCell. addElement(ParagraphElement element)Add an element. | 
| void | XMLTerm. addElement(ParagraphElement element)Add an element. | 
| void | XMLTextStyle. addElement(ParagraphElement element)Add an element. | 
| void | XMLTree. addElement(ParagraphElement element)Add an element. | 
| void | XMLTreeItem. addElement(ParagraphElement element)Add an element. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | AbstractParagraph. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | AbstractXMLAPIDoc. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | ParagraphElementParent. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLBox. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLChapter. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLCode. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLIncludedAPI. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLIncludedAPIArgument. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLIncludedAPIMember. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLInfobox. setElements(java.util.List<ParagraphElement> elements) | 
| void | XMLInfobox.BaseProperty. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLList. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLListItem. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLPre. setElements(java.util.List<ParagraphElement> elements)Set the pre elements. | 
| void | XMLTable. setElements(java.util.List<ParagraphElement> elements) | 
| void | XMLTableCell. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLTerm. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLTextStyle. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLTree. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| void | XMLTreeItem. setElements(java.util.List<ParagraphElement> elements)Set the list of elements. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ArticlesGlossary.WordRepresents one Word in the glossary. | 
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence