Package org.docgene.model

Contains the documentation model.

See: Description

Interface Summary

Interface	Description
Alignment	Represent the alignment.
AnchorElement	Represent an anchored element.
Article	Represents an article interface.
ArticleReference	An article reference.
BorderedElement	An interface for elements which can have a simple or shadowed border.
BorderType	Represent the type of borders.
BulletStyle	Represents the style for list bullets.
ElementReference	Represents a reference to an element.
EmptyElement	A tagging interface for break and empty line elements.
ExternalLink	Represent an external link, which can be a bare link or a link to a class in a Java API.
FallbackArticleType	the enumeation for fallback articles types.
FontNamedSizeType	The list of named sizes for Fonts.
FontType	The font types.
HTMLElement	Represent any element inside an HTML node.
HTMLNode	Represent an HTML node.
HTMLOutput	An HTML root element associated with an output File.
HTMLRootElement	Represent an HTML included content.
ImageHeightType	Represents the type of image height for an image.
ImageReference	Represents an ImageReference.
ImportanceType	The enumeration for importance types used for comments and TODOs.
JustifiedElement	Represents an element which can be justified and/or aligned.
ListElement	Represent any element which can be included in a list.
NonEmptyLineAscendant	A tagging interface for elements for which we don't want to have an empty line after their definition.
NoteContent	Represents the content of a "note" or "noteRef" element.
PaddingType	The padding types, used in tables.
ParagraphArticleReference	An article reference in a paragraph.
ParagraphElement	Represent an element which can be included in a paragraph.
ParagraphElementParent	Represent a parent which can contain Paragraph Elements.
PreScrollingType	The scrolling type for a pre element.
ReviewElement	A review element.
RowBorderType	Represent the type of table row borders.
SpanTextElement
StylableText	A text which may have a decoration.
StyledElement	Represent an element which can be included in a paragraph.
SyntaxType	The syntax types for articles.
TitledElement	Represent a titled element (chapter of title).
TitleOrIncludeElement	A tagging interface which is used for titles and include elements.
TodoElement	A TODO element.
TreeElement	Represent any element which can be included in a tree.
URLLinkElement	The URL link interface.
VerticalAlignment	Represent the vertical alignment.
XMLParent	Represent an element which can have children chapters and paragraphs.
XMLParentArticle	Represents an article which can have children chapters and paragraphs.

Class Summary

Class	Description
AbstractAPI	A general API link.
AbstractJustifiedElement	A ParagraphElement which can be justified depending on if it is the first in its line.
AbstractLink	An abstract Link.
AbstractMoreInfoRef	Represent an "info" or "moreInfo" reference.
AbstractParagraph	Represent the content of a paragraph.
AbstractStylableText	A text which may have a decoration.
AbstractStyledElement	An element with custom styles.
AbstractWikiLink	An abstract wiki link.
AbstractXMLAPIDoc	A general API documentation.
AbstractXMLParent	An abstract XMLParent.
AbstractXMLParentArticle	An abstract XMLParent article.
AlternateTitle	Represents an alternate title.
APIMember	An API member declaration.
ArticleRef	Represent the reference of an article.
HeaderElement	An abstract class for headers and footers.
HTMLCharacters	Represent character content inside an HTML node.
HTMLNode.Default	The node used for all allowed html tags.
HTMLNode.Empty	The empty node, used for not allowed html tags.
ImageMap	Represents an Image map.
ImageMap.Area	Represents an active Area in an Image Map.
OpaqueArticle	An article which is just an opaque reference.
XMLAnchor	Represent an anchor in an article.
XMLAPIDoc	Represent the content of an <apidoc> tag.
XMLAPIDocElement	/** * Represent the content of an <element> tag under an <apidoc>.
XMLArchiveURL	Represent an external link (to a web page or a local file).
XMLArticle	Represents an XML article.
XMLAudio	Represent an link to an embedded audio.
XMLBasicNote	Represent the content of a "note" element.
XMLBlock	Represent the content of a block tag.
XMLBlockquote	Represent the content of a blockquote tag.
XMLBox	Represent the content of a <box> tag.
XMLBreak	Represent the content of a <br> tag.
XMLCategoryReference	Represent an internal reference to a category description.
XMLChapter	Represents a chapter.
XMLCitation	Represent the content of a "cite" element.
XMLCode	Represent the content of a <code> tag.
XMLComment	Represent the content of a <comment> tag.
XMLCommentList	Represent the content of a <commentlist> tag.
XMLCommentList.ArticleComments	The review elements for one article.
XMLCondition	Represents a condition.
XMLDate	Represent the content of a <date> tag.
XMLDisambArticle	Represents an XML disambiguation article.
XMLDiv	Represent a container of sentences.
XMLDotNetAPI	Represent an link to a .NET API.
XMLDoxygenAPI	Represent an link to a Doxygen API.
XMLEmptyLine	Represent the content of an <empty> tag.
XMLExtendedImage	Represent the reference to an image which has a link to an areaRef, a ref, or a link.
XMLExternalLink	Represent an external link (to a web page or a local file).
XMLFallbackArticle	Represents a fallback article.
XMLFooter	Represent the text to be added in the articles footer.
XMLGlossaryReference	Represent an internal reference to the glossary.
XMLHeader	Represent the text to be added in the articles header.
XMLHR	Represent the content of a <hr> tag (a thematic break).
XMLHTMLElement	The element for html embedded content.
XMLIfCondition	Represent the content of a if or else condition.
XMLIfListCondition<E>	Represent the content of a if or else condition, which can contain only one type of element.
XMLImage	Represent the reference to an image.
XMLInclude	Represent an included internal reference (to another article).
XMLIncludedAPI	A general included API link.
XMLIncludedAPIArgument	Represent an argument in an included API method.
XMLIncludedAPIMember	Represent an link to an included API <memberégt; tag under a <javaAPI> or <pythonAPI> tag
XMLIndex	Represents an XML index article.
XMLInfobox	Represent an infobox implementation.
XMLJavaAPI	Represent an link to a Java API.
XMLList	Represent the content of an <ul> or <ol> tag.
XMLListItem	Represent the content of a <li> tag.
XMLMailLink	Represent an email link.
XMLMap	Represent the reference to a Map.
XMLMediawikiLink	Represent a mediawiki link.
XMLMenu	A left or right menu.
XMLMessageBox	Represent the content of a messageBox tag.
XMLMoreInfo	Represent a "moreInfo" reference which is present in a "Main Article" tag.
XMLMoreInfoRef	Represent an "info" ref which is present under a "moreInfo" ref.
XMLNoteRef	Represent the a reference to a note.
XMLParagraph	Represent the content of a paragraph - a <par> tag.
XMLPre	Represent the content of "pre" or "source" tags.
XMLPythonAPI	Represent an link to a python API.
XMLQtAPI	Represent an link to a Qt API.
XMLRawHTMLArticle	The element for a raw html article.
XMLRedirect	Represents an XML redirect article.
XMLReference	Represent an internal reference (to another article).
XMLResource	Represent an internal link (to any file).
XMLSeeAlso	Represent an internal reference which is present in a "See Also" chapter.
XMLSeeAlsoHeading	Represent a "SeeAlso" reference in the article header.
XMLSeeArticle	Represent an internal reference which is present in a "See also" tag in a paragraph.
XMLSentence	Represent a sentence in a paragraph.
XMLSizedTableRow	Represent a Table Row.
XMLSpan	Represent a sentence in a pre element.
XMLTab	Represent the content of a <tab> tag.
XMLTable	Represent the content of a <table> tag.
XMLTableCell	Represent a Table Cell.
XMLTableColumn	Represent a table column.
XMLTableHeader	Represent a Table Header.
XMLTableRow	Represent a Table Row.
XMLTerm	Represent the content of a <term> tag.
XMLTextStyle	Represents the style of a text.
XMLTitle	Represents a title.
XMLTodo	Represent the content of a <todo> tag.
XMLTodoList	Represent the content of a <todolist> tag.
XMLTodoList.ArticleTodos	The TODOs for one article.
XMLTree	Represent the content of an <tree> tag.
XMLTreeItem	Represent the content of a <li> tag in a tree.
XMLVideo	Represent an link to an embedded video.
XMLWikipediaLink	Represent a Wikipedia link.
XMLWord	Represent a word anchor in an article.

Package org.docgene.model Description

Contains the documentation model. The root class is ArticlesModel.