Package | Description |
---|---|
org.docgene.api |
This package allows to generate a wiki in another application, using the docGenerator API.
|
org.docgene.model |
Contains the documentation model.
|
org.docgene.model.globals |
Contains the global elements for the wiki model.
|
Modifier and Type | Method and Description |
---|---|
void |
DocGeneratorAPI.setCustomStyles(StyledElement element,
java.lang.String styleClass,
java.lang.String style)
Set the custom styles for an element.
|
Modifier and Type | Interface and Description |
---|---|
interface |
ArticleReference
An article reference.
|
interface |
EmptyElement
A tagging interface for break and empty line elements.
|
interface |
ExternalLink
Represent an external link, which can be a bare link or a link to a class in a Java API.
|
interface |
HTMLRootElement
Represent an HTML included content.
|
interface |
ListElement
Represent any element which can be included in a list.
|
interface |
ParagraphArticleReference
An article reference in a paragraph.
|
interface |
ParagraphElement
Represent an element which can be included in a paragraph.
|
interface |
SpanTextElement |
interface |
StylableText
A text which may have a decoration.
|
interface |
TreeElement
Represent any element which can be included in a tree.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractAPI
A general API link.
|
class |
AbstractJustifiedElement
A ParagraphElement which can be justified depending on if it is the first in its line.
|
class |
AbstractLink
An abstract Link.
|
class |
AbstractMoreInfoRef
Represent an "info" or "moreInfo" reference.
|
class |
AbstractParagraph
Represent the content of a paragraph.
|
class |
AbstractStylableText
A text which may have a decoration.
|
class |
AbstractStyledElement
An element with custom styles.
|
class |
AbstractWikiLink
An abstract wiki link.
|
class |
AbstractXMLAPIDoc
A general API documentation.
|
class |
XMLAnchor
Represent an anchor in an article.
|
class |
XMLAPIDoc
Represent the content of an <apidoc> tag.
|
class |
XMLAPIDocElement
/**
* Represent the content of an <element> tag under an <apidoc>.
|
class |
XMLArchiveURL
Represent an external link (to a web page or a local file).
|
class |
XMLAudio
Represent an link to an embedded audio.
|
class |
XMLBasicNote
Represent the content of a "note" element.
|
class |
XMLBlock
Represent the content of a block tag.
|
class |
XMLBlockquote
Represent the content of a blockquote tag.
|
class |
XMLBox
Represent the content of a <box> tag.
|
class |
XMLBreak
Represent the content of a <br> tag.
|
class |
XMLCategoryReference
Represent an internal reference to a category description.
|
class |
XMLChapter
Represents a chapter.
|
class |
XMLCitation
Represent the content of a "cite" element.
|
class |
XMLCode
Represent the content of a <code> tag.
|
class |
XMLComment
Represent the content of a <comment> tag.
|
class |
XMLCommentList
Represent the content of a <commentlist> tag.
|
class |
XMLCondition
Represents a condition.
|
class |
XMLDate
Represent the content of a <date> tag.
|
class |
XMLDiv
Represent a container of sentences.
|
class |
XMLDotNetAPI
Represent an link to a .NET API.
|
class |
XMLDoxygenAPI
Represent an link to a Doxygen API.
|
class |
XMLEmptyLine
Represent the content of an <empty> tag.
|
class |
XMLExtendedImage
Represent the reference to an image which has a link to an areaRef, a ref, or a link.
|
class |
XMLExternalLink
Represent an external link (to a web page or a local file).
|
class |
XMLGlossaryReference
Represent an internal reference to the glossary.
|
class |
XMLHR
Represent the content of a <hr> tag (a thematic break).
|
class |
XMLHTMLElement
The element for html embedded content.
|
class |
XMLIfCondition
Represent the content of a if or else condition.
|
class |
XMLImage
Represent the reference to an image.
|
class |
XMLInclude
Represent an included internal reference (to another article).
|
class |
XMLIncludedAPI
A general included API link.
|
class |
XMLIncludedAPIArgument
Represent an argument in an included API method.
|
class |
XMLIncludedAPIMember
Represent an link to an included API <memberégt; tag under a <javaAPI> or <pythonAPI> tag
|
class |
XMLInfobox
Represent an infobox implementation.
|
class |
XMLJavaAPI
Represent an link to a Java API.
|
class |
XMLList
Represent the content of an <ul> or <ol> tag.
|
class |
XMLListItem
Represent the content of a <li> tag.
|
class |
XMLMailLink
Represent an email link.
|
class |
XMLMap
Represent the reference to a Map.
|
class |
XMLMediawikiLink
Represent a mediawiki link.
|
class |
XMLMenu
A left or right menu.
|
class |
XMLMessageBox
Represent the content of a messageBox tag.
|
class |
XMLMoreInfo
Represent a "moreInfo" reference which is present in a "Main Article" tag.
|
class |
XMLMoreInfoRef
Represent an "info" ref which is present under a "moreInfo" ref.
|
class |
XMLNoteRef
Represent the a reference to a note.
|
class |
XMLParagraph
Represent the content of a paragraph - a <par> tag.
|
class |
XMLPre
Represent the content of "pre" or "source" tags.
|
class |
XMLPythonAPI
Represent an link to a python API.
|
class |
XMLQtAPI
Represent an link to a Qt API.
|
class |
XMLRedirect
Represents an XML redirect article.
|
class |
XMLReference
Represent an internal reference (to another article).
|
class |
XMLResource
Represent an internal link (to any file).
|
class |
XMLSeeAlso
Represent an internal reference which is present in a "See Also" chapter.
|
class |
XMLSeeAlsoHeading
Represent a "SeeAlso" reference in the article header.
|
class |
XMLSeeArticle
Represent an internal reference which is present in a "See also" tag in a paragraph.
|
class |
XMLSentence
Represent a sentence in a paragraph.
|
class |
XMLSizedTableRow
Represent a Table Row.
|
class |
XMLSpan
Represent a sentence in a pre element.
|
class |
XMLTab
Represent the content of a <tab> tag.
|
class |
XMLTable
Represent the content of a <table> tag.
|
class |
XMLTableCell
Represent a Table Cell.
|
class |
XMLTableColumn
Represent a table column.
|
class |
XMLTableHeader
Represent a Table Header.
|
class |
XMLTableRow
Represent a Table Row.
|
class |
XMLTerm
Represent the content of a <term> tag.
|
class |
XMLTextStyle
Represents the style of a text.
|
class |
XMLTitle
Represents a title.
|
class |
XMLTodo
Represent the content of a <todo> tag.
|
class |
XMLTodoList
Represent the content of a <todolist> tag.
|
class |
XMLTree
Represent the content of an <tree> tag.
|
class |
XMLTreeItem
Represent the content of a <li> tag in a tree.
|
class |
XMLVideo
Represent an link to an embedded video.
|
class |
XMLWikipediaLink
Represent a Wikipedia link.
|
class |
XMLWord
Represent a word anchor in an article.
|
Modifier and Type | Class and Description |
---|---|
class |
ArticlesGlossary.Word
Represents one Word in the glossary.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence