public final class Task
extends org.apache.tools.ant.taskdefs.MatchingTask
Generates XML Schema documentation using the xsddoc tool.
Attribute | Description | Required |
schemaLoaction | deprecated, see file parameter |
Exactly one of the these or nested <fileset> |
file | shortcut for specifying a single file fileset | |
dir | shortcut for specifying a single folder fileset | |
out | destination directory for output files | Yes |
xml | If output should be XML instead of HTML. (yes | no). Default is no | No |
css | provide external CSS file | & |
title | deprecated, see doctitle parameter | No |
doctitle | Include title for the package index(first) page (html-code) | No |
header | Include header text for each page (html-code) | No |
footer | Include footer text for each page (html-code) | No |
bottom | Include bottom text for each page (html-code) | No |
failonerror | Log a warning message, but do not stop the build, when the file to copy does not exist or one of the nested filesets points to a directory that doesn't exist or an error occurs while copying. (yes | no). Default is no | No |
verbose | Output messages about what xsddoc is doing. (yes | no). Default is yes | No |
quiet | Be quiet about what xsddoc is doing. (yes | no). Default is no | No |
debug | Output internal messages about what xsddoc is doing. (yes | no). Default is no | No |
hideSubTypes | hide sub types references. (yes | no). Default is no | No |
hideLocalUsage | hide local usage references. (yes | no). Default is no | No |
hideTypes | hide types in overview pages. (yes | no). Default is no | No |
hideGroups | hide groups in overview pages. (yes | no). Default is no | No |
hideAttributes | hide attributes in overview pages. (yes | no). Default is no | No |
FileSets are used to select sets of files to process. To use a fileset, the todir attribute must be set.
Same as the doctitle
attribute, but you can nest text
inside the element this way.
Similar to <doctitle>
.
Similar to <doctitle>
.
Similar to <doctitle>
.
<!--
Define xsddoc task.
-->
<taskdef name="xsddoc" classname="net.sf.xframe.xsddoc.Task"/>
<!--
Use xsddoc task.
-->
<xsddoc file="myschema.xsd"
out="doc/schema/myschema">
<doctitle><![CDATA[XML Schema
for XML Schema]]></doctitle>
</xsddoc>
Modifier and Type | Class and Description |
---|---|
static class |
Task.Html
An HTML fragment in a nested element of the xsddoc task.
|
Constructor and Description |
---|
Task()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addBottom(Task.Html theBottom)
Set the text to be placed at the bottom of each output file.
|
void |
addDoctitle(Task.Html text)
Add a document title to use for the overview page.
|
void |
addFileset(org.apache.tools.ant.types.FileSet set)
Adds a set of files to be deleted.
|
void |
addFooter(Task.Html text)
Set the footer text to be placed at the bottom of each output file.
|
void |
addHeader(Task.Html theHeader)
Set the header text to be placed at the top of each output file.
|
void |
execute()
Execute xsddoc task.
|
void |
setBottom(java.lang.String theBottom)
Set the text to be placed at the bottom of each output file.
|
protected void |
setCreateFolder(boolean createFolder)
Setter method for createFolder attribute.
|
void |
setCss(java.lang.String css)
Setter method for css property.
|
void |
setDebug(boolean isDebug)
Setter method for debug property.
|
void |
setDir(java.lang.String theDir)
Setter method for dir property.
|
void |
setDoctitle(java.lang.String theDoctitle)
Set the title of the generated overview page.
|
void |
setFailonerror(boolean isFailonerror)
Setter method for failonerror attribute.
|
void |
setFile(java.lang.String theFile)
Setter method for file property.
|
void |
setFooter(java.lang.String theFooter)
Set the footer text to be placed at the bottom of each output file.
|
void |
setHeader(java.lang.String theHeader)
Set the header text to be placed at the top of each output file.
|
void |
setHideattributes(boolean hideAttributes)
Setter method for hideAttributes property.
|
void |
setHidegroups(boolean hideGroups)
Setter method for hideGroups property.
|
void |
setHidelocalusage(boolean hideLocalUsage)
Setter method for hideLocalUsage property.
|
void |
setHidesubtypes(boolean hideSubTypes)
Setter method for hideSubTypes property.
|
void |
setHidetypes(boolean hideTypes)
Setter method for hideTypes property.
|
protected void |
setLauch(boolean launch)
Setter method for lauch attribute.
|
void |
setOut(java.lang.String out)
Setter method for out property.
|
void |
setQuiet(boolean isQuiet)
Setter method for quiet property.
|
void |
setSchemalocation(java.lang.String schemaLocation)
Deprecated.
use
setFile(java.lang.String) instead |
void |
setTitle(java.lang.String title)
Deprecated.
use
setDoctitle(java.lang.String) instead |
void |
setVerbose(boolean isVerbose)
Setter method for verbose property.
|
void |
setXml(boolean isXml)
Setter method for xml attribute.
|
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
- if execution of xsddoc task failedpublic void setDebug(boolean isDebug)
isDebug
- output debug information or notpublic void setOut(java.lang.String out)
out
- output folder to usepublic void setSchemalocation(java.lang.String schemaLocation)
setFile(java.lang.String)
insteadschemaLocation
- location of XML schema to usesetFile(java.lang.String)
public void setFile(java.lang.String theFile)
theFile
- location of XML schemapublic void setDir(java.lang.String theDir)
theDir
- folder to search for schemaspublic void setTitle(java.lang.String title)
setDoctitle(java.lang.String)
insteadtitle
- title to usesetDoctitle(java.lang.String)
public void setCss(java.lang.String css)
css
- location of XML schemapublic void setVerbose(boolean isVerbose)
isVerbose
- be verbose or notpublic void setQuiet(boolean isQuiet)
isQuiet
- be quiet or notpublic void setHidelocalusage(boolean hideLocalUsage)
hideLocalUsage
- if local usage should be hidden or notpublic void setHidesubtypes(boolean hideSubTypes)
hideSubTypes
- if sub types should be hidden or notpublic void setHidetypes(boolean hideTypes)
hideTypes
- if types should be hidden or notpublic void setHideattributes(boolean hideAttributes)
hideAttributes
- if attributes should be hidden or notpublic void setHidegroups(boolean hideGroups)
hideGroups
- if groups should be hidden or notpublic void setXml(boolean isXml)
isXml
- booleanpublic void setFailonerror(boolean isFailonerror)
isFailonerror
- if should fail on error or notpublic void addFileset(org.apache.tools.ant.types.FileSet set)
set
- the set of files to be deletedpublic void addDoctitle(Task.Html text)
text
- the HTML element containing the document title.public void setDoctitle(java.lang.String theDoctitle)
theDoctitle
- the Document title.public void setHeader(java.lang.String theHeader)
theHeader
- the header textpublic void addHeader(Task.Html theHeader)
theHeader
- the header textpublic void addFooter(Task.Html text)
text
- the footer text.public void setFooter(java.lang.String theFooter)
theFooter
- the footer text.public void setBottom(java.lang.String theBottom)
theBottom
- the bottom text.public void addBottom(Task.Html theBottom)
theBottom
- the bottom text.protected void setCreateFolder(boolean createFolder)
createFolder
- if out folder should be createdprotected void setLauch(boolean launch)
launch
- if documentation should be launched in browserSubmit a
bug or a
feature.
Created by
xsddoc, a sub project of
xframe, hosted at
http://www.sourceforge.net.