|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectTask
org.doxygen.tools.DoxygenTask
Ant task for Doxygen. This task provides a mapping between
all current Doxygen configuration file options (as of 1.2.18)
and Ant build files.
\par Doxygen and JavaDoc co-existence.
\note This file uses a combination of JavaDoc and Doxygen
formatting codes. Doxygen tags begin with a single back-slash
instead of the JavaDoc standard at-sign. This reduces the number
of warnings which JavaDoc issues when parsing a Doxygen documented
file while also including that text in JavaDoc output (albeit
poorly formatted).
By placing all Doxygen paragraphs before any JavaDoc paragraphs,
all text will naturally flow into the body of the main paragraph
(for a graceful degradation).
Also, but placing one or two HTML <br> tags at the end of
each paragraph, the degradation from Doxygen to JavaDoc will be
less severe.
Nested Class Summary | |
static class |
DoxygenTask.Property
This inner class implements a nested Ant XML property container. |
Field Summary | |
static java.lang.String |
CONFIG_FILE
Name of the temporary configuration file that will be created in ${user.home}. |
Constructor Summary | |
DoxygenTask()
Initializes the Doxygen Configuration options. |
Method Summary | |
void |
activityLog(boolean terseMessage,
java.lang.String theMessage)
This method allows a single point of control over the task output verbosity. |
DoxygenTask.Property |
createProperty()
This method enables nested property tags. |
void |
execute()
This is the main execution entry-point of the task. |
java.util.Map |
getTaskAttributes()
|
java.lang.String |
getVersionCompatible()
|
void |
setConfig(java.lang.String name,
java.lang.String value)
|
void |
setConfigFilename(java.lang.String attr)
Core Ant task element which specifies an non-generated Doxygen base configuration file. |
void |
setDoxygenPath(java.lang.String attr)
Core Ant task element which specifies a path to the Doxygen executable. |
void |
setVerbose(boolean attr)
Core Ant task element that controls the output verbosity of this Ant task. |
void |
setVersionCompatible(java.lang.String newVersion)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CONFIG_FILE
Constructor Detail |
public DoxygenTask()
Method Detail |
public final void execute() throws BuildException
BuildException
- thrown in case any problem executing
the task.public final void setVersionCompatible(java.lang.String newVersion)
newVersion
- Sets the version against which compatibility
check is to be run.public final java.lang.String getVersionCompatible()
public final void setVerbose(boolean attr)
attr
- from build.xml.public final void setConfigFilename(java.lang.String attr)
attr
- from build.xml.public final void setDoxygenPath(java.lang.String attr)
attr
- from build.xml.public final DoxygenTask.Property createProperty()
Property
.public final void setConfig(java.lang.String name, java.lang.String value)
name
- Name of the configuration property.public java.util.Map getTaskAttributes()
public final void activityLog(boolean terseMessage, java.lang.String theMessage)
terseMessage
- is a flag that indicates the calling code
wants this message to appear regardless of the current
verbosity level.theMessage
- to be output, guard condition permitting.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |