| Package | Description |
|---|---|
| org.docgene.api |
This package allows to generate a wiki in another application, using the docGenerator API.
|
| org.docgene.main |
Contains the entry point of the application.
|
| org.docgene.model |
Contains the documentation model.
|
| org.docgene.model.globals |
Contains the global elements for the wiki model.
|
| Class and Description |
|---|
| AbstractParagraph
Represent the content of a paragraph.
|
| AnchorElement
Represent an anchored element.
|
| OpaqueArticle
An article which is just an opaque reference.
|
| ParagraphElementParent
Represent a parent which can contain Paragraph Elements.
|
| StyledElement
Represent an element which can be included in a paragraph.
|
| XMLAnchor
Represent an anchor in an article.
|
| XMLArticle
Represents an XML article.
|
| XMLExternalLink
Represent an external link (to a web page or a local file).
|
| XMLFooter
Represent the text to be added in the articles footer.
|
| XMLHeader
Represent the text to be added in the articles header.
|
| XMLImage
Represent the reference to an image.
|
| XMLIndex
Represents an XML index article.
|
| XMLList
Represent the content of an <ul> or <ol> tag.
|
| XMLListItem
Represent the content of a <li> tag.
|
| XMLMenu
A left or right menu.
|
| XMLParagraph
Represent the content of a paragraph - a <par> tag.
|
| XMLParent
Represent an element which can have children chapters and paragraphs.
|
| XMLParentArticle
Represents an article which can have children chapters and paragraphs.
|
| XMLReference
Represent an internal reference (to another article).
|
| XMLSentence
Represent a sentence in a paragraph.
|
| XMLSizedTableRow
Represent a Table Row.
|
| 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.
|
| XMLTextStyle
Represents the style of a text.
|
| XMLTitle
Represents a title.
|
| Class and Description |
|---|
| XMLParentArticle
Represents an article which can have children chapters and paragraphs.
|
| Class and 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.
|
| Alignment
Represent the alignment.
|
| AlternateTitle
Represents an alternate title.
|
| AnchorElement
Represent an anchored element.
|
| APIMember
An API member declaration.
|
| APIMember.Argument
An API member argument.
|
| Article
Represents an article interface.
|
| ArticleRef
Represent the reference of an article.
|
| ArticleReference
An article reference.
|
| BorderedElement
An interface for elements which can have a simple or shadowed border.
|
| 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.
|
| FontType
The font types.
|
| HeaderElement
An abstract class for headers and footers.
|
| HTMLElement
Represent any element inside an HTML node.
|
| HTMLNode
Represent an HTML node.
|
| HTMLNode.Empty
The empty node, used for not allowed html tags.
|
| 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.
|
| ImageMap
Represents an Image map.
|
| ImageMap.Area
Represents an active Area in an Image Map.
|
| 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.
|
| MessageBoxType
The
XMLMessageBox types. |
| 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.
|
| OpaqueArticle
An article which is just an opaque reference.
|
| 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.
|
| ReviewElement
A review element.
|
| SpanTextElement |
| StylableText
A text which may have a decoration.
|
| StyledElement
Represent an element which can be included in a paragraph.
|
| 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.
|
| XMLAnchor
Represent an anchor in an article.
|
| XMLAPIDocElement
/**
* Represent the content of an <element> tag under an <apidoc>.
|
| XMLArticle
Represents an XML article.
|
| XMLBlock
Represent the content of a block tag.
|
| XMLBlockquote
Represent the content of a blockquote tag.
|
| XMLCategoryReference
Represent an internal reference to a category description.
|
| XMLChapter
Represents a chapter.
|
| XMLComment
Represent the content of a <comment> tag.
|
| XMLCommentList
Represent the content of a <commentlist> tag.
|
| XMLCommentList.ArticleComments
The review elements for one article.
|
| 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).
|
| XMLIfCondition
Represent the content of a if or else condition.
|
| 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
|
| XMLInfobox
Represent an infobox implementation.
|
| XMLInfobox.BaseProperty
An infobox property.
|
| XMLInfobox.EnumProperty
An infobox enum property.
|
| XMLInfobox.Property
An infobox property.
|
| XMLList
Represent the content of an <ul> or <ol> tag.
|
| XMLListItem
Represent the content of a <li> tag.
|
| XMLMap
Represent the reference to a Map.
|
| XMLMessageBox
Represent the content of a messageBox 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.
|
| XMLParent
Represent an element which can have children chapters and paragraphs.
|
| XMLParentArticle
Represents an article which can have children chapters and paragraphs.
|
| XMLRawHTMLArticle
The element for a raw html article.
|
| XMLReference
Represent an internal reference (to another article).
|
| XMLSeeAlso
Represent an internal reference which is present in a "See Also" chapter.
|
| XMLSeeAlsoHeading
Represent a "SeeAlso" reference in the article header.
|
| 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.
|
| XMLTextStyle
Represents the style of a text.
|
| XMLTitle
Represents a title.
|
| 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.
|
| Class and Description |
|---|
| AbstractXMLParent
An abstract XMLParent.
|
| AbstractXMLParentArticle
An abstract XMLParent article.
|
| AnchorElement
Represent an anchored element.
|
| Article
Represents an article interface.
|
| ArticleRef
Represent the reference of an article.
|
| ArticleReference
An article reference.
|
| ElementReference
Represents a reference to an element.
|
| HTMLOutput
An HTML root element associated with an output File.
|
| ParagraphArticleReference
An article reference in a paragraph.
|
| ParagraphElement
Represent an element which can be included in a paragraph.
|
| StyledElement
Represent an element which can be included in a paragraph.
|
| TodoElement
A TODO element.
|
| XMLArticle
Represents an XML article.
|
| XMLComment
Represent the content of a <comment> tag.
|
| XMLCommentList
Represent the content of a <commentlist> tag.
|
| XMLDisambArticle
Represents an XML disambiguation article.
|
| XMLFallbackArticle
Represents a fallback article.
|
| XMLFooter
Represent the text to be added in the articles footer.
|
| XMLHeader
Represent the text to be added in the articles header.
|
| XMLIndex
Represents an XML index article.
|
| XMLParent
Represent an element which can have children chapters and paragraphs.
|
| XMLParentArticle
Represents an article which can have children chapters and paragraphs.
|
| XMLResource
Represent an internal link (to any file).
|
| XMLTodoList
Represent the content of a <todolist> tag.
|
| XMLWord
Represent a word anchor in an article.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence