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. <br/><br/>
Definition at line 110 of file DoxygenTask.java.
Public Member Functions | |
DoxygenTask () | |
final void | execute () throws BuildException |
final void | setVersionCompatible (String newVersion) |
final String | getVersionCompatible () |
final void | setVerbose (final boolean attr) |
final void | setConfigFilename (final String attr) |
final void | setDoxygenPath (final String attr) |
final Property | createProperty () |
final void | setConfig (String name, String value) |
Map | getTaskAttributes () |
final void | activityLog (final boolean terseMessage, final String theMessage) |
Static Public Attributes | |
final String | CONFIG_FILE |
|
Initializes the Doxygen Configuration options. Definition at line 155 of file DoxygenTask.java.
00155 { 00156 proc = new DoxygenProcess(); 00157 conf = new DoxygenConfig(); 00158 } |
|
This method allows a single point of control over the task output verbosity. <br/>
Definition at line 312 of file DoxygenTask.java.
00313 { 00314 if (theMessage != null) { 00315 if (terseMessage || verbose) { 00316 System.out.println(theMessage); 00317 } 00318 } 00319 } |
|
This method enables nested property tags. This is the preferred attribute specification method as it reduces the acute knowledge that the task has over a given Doxygen implementation. However, non-nested attributes may still be specified. <br/>
Definition at line 272 of file DoxygenTask.java. References org.doxygen.tools.DoxygenConfig.addNestedAttribute().
00272 { 00273 Property p = new Property(); 00274 conf.addNestedAttribute(p); 00275 return p; 00276 } |
|
This is the main execution entry-point of the task.
Definition at line 168 of file DoxygenTask.java. References org.doxygen.tools.DoxygenProcess.checkVersion(), org.doxygen.tools.DoxygenTask.CONFIG_FILE, org.doxygen.tools.DoxygenProcess.createConfig(), org.doxygen.tools.DoxygenProcess.executeDoxygenConfig(), and org.doxygen.tools.DoxygenConfig.writeDoxygenConfig().
00168 { 00169 proc.checkVersion(versionCompatible); 00170 System.out.println("Version check complete"); 00171 if (configFilename == null ) { 00172 configFilename = CONFIG_FILE; 00173 proc.createConfig(configFilename); 00174 } 00175 conf.writeDoxygenConfig(configFilename); // Then we update it. 00176 System.out.println("Created Config file"); 00177 proc.executeDoxygenConfig(configFilename); 00178 00179 // No need to delete the config. file at all. 00180 //Let it be there for the user to know what was used. 00181 } |
|
Definition at line 295 of file DoxygenTask.java. References org.doxygen.tools.DoxygenConfig.getTaskAttributes().
00295 {
00296 return conf.getTaskAttributes();
00297 }
|
|
Definition at line 197 of file DoxygenTask.java.
00197 {
00198 return versionCompatible;
00199 }
|
|
Definition at line 283 of file DoxygenTask.java. References org.doxygen.tools.DoxygenConfig.addNestedAttribute().
00283 {
00284 Property p = new Property();
00285 p.setName(name);
00286 p.setValue(value);
00287 conf.addNestedAttribute(p);
00288 }
|
|
Core Ant task element which specifies an non-generated Doxygen base configuration file. All <doxygen> elements and nested elements that appear in the build.xml file will take precedence over this base configuration. <br/><br/> The base configuration file will not be updated. Doxygen will be invoked with an amalgamated configuration file which is derived from either this configuration file or if not specified, a Doxygen default and then Ant task flavored almalgamated configuration file. <br/><br/>
Definition at line 238 of file DoxygenTask.java.
00238 { 00239 configFilename = attr; 00240 } |
|
Core Ant task element which specifies a path to the Doxygen executable. By default the application name "doxygen" is used which presumes Doxygen is on the path. <br/>
Definition at line 255 of file DoxygenTask.java. References org.doxygen.tools.DoxygenProcess.setDoxygenPath().
00255 { 00256 proc.setDoxygenPath(attr); 00257 } |
|
Core Ant task element that controls the output verbosity of this Ant task. By default, verbosity is minimized to allow for cleaner build logs. Turn this on, if you need more detailed diagnostic information. <br/>
Definition at line 217 of file DoxygenTask.java.
00217 { verbose = attr; } |
|
Definition at line 188 of file DoxygenTask.java.
00188 { 00189 versionCompatible = newVersion; 00190 } |
|
Initial value: System.getProperty("user.home") + File.separator + ".doxytmp" Definition at line 116 of file DoxygenTask.java. Referenced by org.doxygen.tools.DoxygenTask.execute(). |