de.oscillation.maven.doxygen
public abstract class AbstractDoxygenMojo extends org.apache.maven.plugin.AbstractMojo
| Modifier and Type | Field and Description |
|---|---|
protected String |
outputBasePath
The base path for Doxygen output files.
|
protected List<DoxygenOutputGenerator> |
outputGenerators
List of all available Doxygen output generators.
|
protected StringWriter |
stringWriter
String writer for console output.
|
protected org.codehaus.plexus.util.cli.StreamConsumer |
systemErr
Stream consumer for
stderr. |
protected org.codehaus.plexus.util.cli.StreamConsumer |
systemOut
Stream consumer for
stdout. |
| Constructor and Description |
|---|
AbstractDoxygenMojo() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
checkExecutable()
Checks if calling the Doxygen executable works.
|
protected void |
ensureDoxyfile()
Checks if the Doxygen configuration file exists.
|
void |
execute()
Checks the Doxygen executable, generates the Doxyfile if necessary and
parses relevant parameters from it.
|
String |
getDoxyfilePath() |
String |
getExecutablePath() |
File |
getWorkingDirectory() |
protected abstract void |
performTasks()
All goal specific tasks are performed in this function, which is called by
execute(). |
protected void |
readOutputParametersFromDoxyfile()
Parses the Doxygen configuration file and extracts information on output generators.
|
boolean |
shouldAutogen() |
protected StringWriter stringWriter
protected org.codehaus.plexus.util.cli.StreamConsumer systemOut
stdout.protected org.codehaus.plexus.util.cli.StreamConsumer systemErr
stderr.protected String outputBasePath
protected List<DoxygenOutputGenerator> outputGenerators
protected void checkExecutable()
protected void ensureDoxyfile()
autogen flag was set in pom.xml,
the file is automatically generated.
Otherwise the execution is aborted with an error message.protected void readOutputParametersFromDoxyfile()
outputBasePath and outputGenerators.protected abstract void performTasks()
execute().public void execute()
throws org.apache.maven.plugin.MojoExecutionException
performTasks() after the initialization.org.apache.maven.plugin.MojoExecutionExceptionMojo.execute()public boolean shouldAutogen()
true if the autogen flag is setpublic String getDoxyfilePath()
public String getExecutablePath()
public File getWorkingDirectory()
Copyright © 2014 os-cillation GmbH. All rights reserved.