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.
|
Modifier and Type | Method and Description |
---|---|
ParagraphElementParent |
DocGeneratorAPI.getOrCreateLastParagraphParent(XMLArticle article)
Return the last paragraph parent for an article, or create one if it does not exist.
|
Modifier and Type | Method and Description |
---|---|
XMLAnchor |
DocGeneratorAPI.addAnchor(XMLArticle article,
ParagraphElementParent parent,
java.lang.String anchorID,
java.lang.String text)
Add an anchor.
|
XMLAnchor |
DocGeneratorAPI.addAnchor(XMLArticle article,
ParagraphElementParent parent,
java.lang.String anchorID,
java.lang.String text,
int type)
Add an anchor.
|
void |
DocGeneratorAPI.addBreak(ParagraphElementParent parent)
Add a break.
|
void |
DocGeneratorAPI.addEmptyLine(ParagraphElementParent parent)
Add an empty line.
|
XMLExternalLink |
DocGeneratorAPI.addExternalLink(ParagraphElementParent parent,
java.net.URL url,
java.lang.String desc)
Add an external link.
|
XMLImage |
DocGeneratorAPI.addImage(org.docgene.model.globals.XMLRootElement element,
ParagraphElementParent parent,
java.awt.image.BufferedImage bimg,
boolean br)
Add an image.
|
XMLImage |
DocGeneratorAPI.addImage(org.docgene.model.globals.XMLRootElement element,
ParagraphElementParent parent,
java.io.File imageFile,
boolean br)
Add an image.
|
XMLImage |
DocGeneratorAPI.addImage(org.docgene.model.globals.XMLRootElement element,
ParagraphElementParent parent,
java.lang.String imageID,
boolean br)
Add an image.
|
XMLImage |
DocGeneratorAPI.addImage(org.docgene.model.globals.XMLRootElement element,
ParagraphElementParent parent,
java.net.URL url,
boolean br)
Add an image.
|
XMLList |
DocGeneratorAPI.addList(ParagraphElementParent parent,
boolean isUL)
Add a list.
|
void |
DocGeneratorAPI.addMultilineSentence(ParagraphElementParent parent,
java.lang.String text)
Add a multiline sentence.
|
void |
DocGeneratorAPI.addMultilineSentence(ParagraphElementParent parent,
java.lang.String text,
int type)
Add a multiline sentence.
|
void |
DocGeneratorAPI.addMultilineSentence(ParagraphElementParent parent,
java.lang.String text,
SentenceStyle style)
Add a multiline sentence, setting also its style.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
AnchorElement anchor)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
AnchorElement anchor,
java.lang.String desc)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
java.lang.String refID)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
java.lang.String refID,
java.lang.String desc)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
XMLParentArticle refArticle)
Add a reference.
|
XMLReference |
DocGeneratorAPI.addReference(XMLArticle article,
ParagraphElementParent parent,
XMLParentArticle refArticle,
java.lang.String desc)
Add a reference.
|
XMLSentence |
DocGeneratorAPI.addSentence(ParagraphElementParent parent,
java.lang.String text)
Add a sentence.
|
XMLSentence |
DocGeneratorAPI.addSentence(ParagraphElementParent parent,
java.lang.String text,
int type)
Add a sentence.
|
XMLSentence |
DocGeneratorAPI.addSentence(ParagraphElementParent parent,
java.lang.String text,
int type,
int size)
Add a sentence.
|
XMLSentence |
DocGeneratorAPI.addSentence(ParagraphElementParent parent,
java.lang.String text,
SentenceStyle style)
Add a sentence, setting also its style.
|
void |
DocGeneratorAPI.addTab(ParagraphElementParent parent)
Add an tabulation.
|
XMLTable |
DocGeneratorAPI.addTable(XMLArticle article,
ParagraphElementParent parent,
boolean isSortable)
Add a table.
|
XMLTextStyle |
DocGeneratorAPI.addTextStyle(ParagraphElementParent parent,
SentenceStyle style)
Add a text style.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
ParagraphElementParent parent,
int level,
java.lang.String title,
boolean keepCase)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
ParagraphElementParent parent,
int level,
java.lang.String title,
boolean keepCase,
boolean isSearchable)
Add a title for the article.
|
XMLTitle |
DocGeneratorAPI.addTitle(XMLArticle article,
ParagraphElementParent parent,
java.lang.String title)
Add a title for the article, at level 1.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractParagraph
Represent the content of a paragraph.
|
class |
AbstractXMLAPIDoc
A general API documentation.
|
class |
XMLAPIDoc
Represent the content of an <apidoc> tag.
|
class |
XMLAPIDocElement
/**
* Represent the content of an <element> tag under an <apidoc>.
|
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 |
XMLChapter
Represents a chapter.
|
class |
XMLCode
Represent the content of a <code> tag.
|
class |
XMLDiv
Represent a container of sentences.
|
class |
XMLIfCondition
Represent the content of a if or else condition.
|
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 |
XMLInfobox.BaseProperty
An infobox property.
|
class |
XMLList
Represent the content of an <ul> or <ol> tag.
|
class |
XMLListItem
Represent the content of a <li> tag.
|
class |
XMLMessageBox
Represent the content of a messageBox tag.
|
class |
XMLParagraph
Represent the content of a paragraph - a <par> tag.
|
class |
XMLPre
Represent the content of "pre" or "source" tags.
|
class |
XMLTable
Represent the content of a <table> tag.
|
class |
XMLTableCell
Represent a Table Cell.
|
class |
XMLTableColumn
Represent a table column.
|
class |
XMLTerm
Represent the content of a <term> tag.
|
class |
XMLTextStyle
Represents the style of a text.
|
class |
XMLTree
Represent the content of an <tree> tag.
|
class |
XMLTreeItem
Represent the content of a <li> tag in a tree.
|
Copyright © 2016-2024 Herve Girod. All Rights Reserved. Documentation and source under the BSD licence