com.soebes.maven.plugins.doxygen

Class AbstractDoxygenMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.soebes.maven.plugins.doxygen.AbstractDoxygenConfigurationMojo

com.soebes.maven.plugins.doxygen.AbstractDoxygenMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

DoxygenReport

public abstract class AbstractDoxygenMojo
extends AbstractDoxygenConfigurationMojo

This abstract class contains all configurable parameters for the doxygen plugin.

Author:

Karl Heinz Marbaise

Field Summary

Fields

Modifier and Type	Field and Description
private File	basedir This is the basedir.
private String	executable This defines the name and/or the absolute path to he doxygen executable.
private File	outputDirectory The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) base path where the generated documentation will be put.
private org.apache.maven.execution.MavenSession	session The current build session instance.
private boolean	skip This is the skip parameter to simply skip the doxygen generation part.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDoxygenMojo()

Method Summary

Methods

Modifier and Type	Method and Description
private void	addConfiguration(PrintWriter config, DoxygenParameters key, boolean value) This is called for boolean configuration items.
private void	addConfiguration(PrintWriter config, DoxygenParameters key, Integer value) This is called for integer configuration items.
private void	addConfiguration(PrintWriter config, DoxygenParameters key, String value) This is called for String configuration items.
private void	addConfiguration(PrintWriter config, String desc, String key, String value) This will write all kind of configuration items into the configuration file and will format the file.
File	buildConfigurationFile() This method will get an existing configuration file for doxygen or will create a new one with the configured parameters.
void	buildConfigurationFile(File config) This method will create the configuration for calling doxygen.
protected void	executeReport(Locale unusedLocale)
File	getBasedir()
private String	getExecutablePath() This will check if the given information for the doxygen executable is enough.
protected File	getOutputDirectory()
private org.apache.maven.toolchain.Toolchain	getToolchain() This code is lent from http://fisheye.codehaus.org/browse/~raw,r=8882/mojo/trunk/mojo/exec-maven-plugin/src/main/java/org/codehaus/mojo/ exec/ExecMojo.java
boolean	isSkip()
void	setBasedir(File basedir)
void	setOutputDirectory(File outputDirectory)
void	setSkip(boolean skip)

Methods inherited from class com.soebes.maven.plugins.doxygen.AbstractDoxygenConfigurationMojo

getAbbreviateBrief, getAliases, getChmFile, getChmIndexEncoding, getColsInAlphaIndex, getConfigurationFile, getDocsetBundleId, getDocsetFeedname, getDotfileDirs, getDotFontname, getDotFontpath, getDotFontsize, getDotGraphMaxNodes, getDotImageFormat, getDotPath, getDoxyfileEncoding, getEnabledSections, getEnumValuesPerLine, getExamplePath, getExamplePatterns, getExclude, getExcludePatterns, getExcludeSymbols, getExpandAsDefined, getExtraPackages, getFilePatterns, getFileVersionFilter, getFilterPatterns, getFormulaFontsize, getGenerateTagfile, getGenerateTreeview, getHhcLocation, getHtmlFileExtension, getHtmlFooter, getHtmlHeader, getHtmlOutput, getHtmlStylesheet, getIgnorePrefix, getImagePath, getIncludeFilePatterns, getIncludePath, getInput, getInputEncoding, getInputFilter, getLatexCmdName, getLatexHeader, getLatexOutput, getLayoutFile, getMakeindexCmdName, getManExtension, getManOutput, getMaxDotGraphDepth, getMaxInitializerLines, getMscgenPath, getOutputLanguage, getPaperType, getPerlmodMakevarPrefix, getPerlPath, getPredefined, getProjectName, getProjectNumber, getQchFile, getQhgLocation, getQhpNamespace, getQhpVirtualFolder, getRtfExtensionsFile, getRtfOutput, getRtfStylesheetFile, getStripFromIncPath, getStripFromPath, getSymbolCacheSize, getTabSize, getTagfiles, getTreeviewWidth, getWarnFormat, getWarnLogfile, getXmlDtd, getXmlOutput, getXmlSchema, isAllexternals, isAlphabeticalIndex, isAlwaysDetailedSec, isBinaryToc, isBriefMemberDesc, isBuiltinStlSupport, isCallerGraph, isCallGraph, isCaseSenseNames, isClassDiagrams, isClassGraph, isCollaborationGraph, isCompactLatex, isCompactRtf, isCppCliSupport, isCreateSubdirs, isDirectoryGraph, isDisableIndex, isDistributeGroupDoc, isDotCleanup, isDotMultiTargets, isDotTransparent, isEnablePreprocessing, isExampleRecursive, isExcludeSymlinks, isExpandOnlyPredef, isExternalGroups, isExtractAll, isExtractAnonNspaces, isExtractLocalClasses, isExtractLocalMethods, isExtractPrivate, isExtractStatic, isFilterSourceFiles, isFullPathNames, isGenerateAutogenDef, isGenerateBuglist, isGenerateChi, isGenerateDeprecatedlist, isGenerateDocset, isGenerateHtml, isGenerateHtmlhelp, isGenerateLatex, isGenerateLegend, isGenerateMan, isGeneratePerlmod, isGenerateQhp, isGenerateRtf, isGenerateTestlist, isGenerateTodolist, isGenerateXml, isGraphicalHierarchy, isGroupGraphs, isHaveDot, isHideFriendCompounds, isHideInBodyDocs, isHideScopeNames, isHideUndocClasses, isHideUndocMembers, isHideUndocRelations, isHtmlAlignMembers, isHtmlDynamicSections, isIdlPropertySupport, isIncludedByGraph, isIncludeGraph, isInheritDocs, isInlineInfo, isInlineInheritedMemb, isInlineSources, isInternalDocs, isJavadocAutobrief, isLatexBatchmode, isLatexHideIndices, isMacroExpansion, isManLinks, isMultilineCppIsBrief, isOptimizeForFortran, isOptimizeOutputForC, isOptimizeOutputJava, isOptimizeOutputVhdl, isPdfHyperlinks, isPerlmodLatex, isPerlmodPretty, isQtAutobrief, isQuiet, isRecursive, isReferencedByRelation, isReferencesLinkSource, isReferencesRelation, isRepeatBrief, isRtfHyperlinks, isSearchengine, isSearchIncludes, isSeparateMemberPages, isShortNames, isShowDirectories, isShowFiles, isShowIncludeFiles, isShowNamespaces, isShowUsedFiles, isSipSupport, isSkipFunctionMacros, isSortBriefDocs, isSortByScopeName, isSortGroupNames, isSortMemberDocs, isSourceBrowser, isStripCodeComments, isSubgrouping, isTemplateRelations, isTocExpand, isTypedefHidesStruct, isUmlLook, isUseHtags, isUsePdflatex, isVerbatimHeaders, isWarnIfDocError, isWarnIfUndocumented, isWarnings, isWarnNoParamdoc, isXmlProgramlisting, setAbbreviateBrief, setAliases, setAllexternals, setAlphabeticalIndex, setAlwaysDetailedSec, setBinaryToc, setBriefMemberDesc, setBuiltinStlSupport, setCallerGraph, setCallGraph, setCaseSenseNames, setChmFile, setChmIndexEncoding, setClassDiagrams, setClassGraph, setCollaborationGraph, setColsInAlphaIndex, setCompactLatex, setCompactRtf, setConfigurationFile, setCppCliSupport, setCreateSubdirs, setDirectoryGraph, setDisableIndex, setDistributeGroupDoc, setDocsetBundleId, setDocsetFeedname, setDotCleanup, setDotfileDirs, setDotFontname, setDotFontpath, setDotFontsize, setDotGraphMaxNodes, setDotImageFormat, setDotMultiTargets, setDotPath, setDotTransparent, setDoxyfileEncoding, setEnabledSections, setEnablePreprocessing, setEnumValuesPerLine, setExamplePath, setExamplePatterns, setExampleRecursive, setExclude, setExcludePatterns, setExcludeSymbols, setExcludeSymlinks, setExpandAsDefined, setExpandOnlyPredef, setExternalGroups, setExtractAll, setExtractAnonNspaces, setExtractLocalClasses, setExtractLocalMethods, setExtractPrivate, setExtractStatic, setExtraPackages, setFilePatterns, setFileVersionFilter, setFilterPatterns, setFilterSourceFiles, setFormulaFontsize, setFullPathNames, setGenerateAutogenDef, setGenerateBuglist, setGenerateChi, setGenerateDeprecatedlist, setGenerateDocset, setGenerateHtml, setGenerateHtmlhelp, setGenerateLatex, setGenerateLegend, setGenerateMan, setGeneratePerlmod, setGenerateQhp, setGenerateRtf, setGenerateTagfile, setGenerateTestlist, setGenerateTodolist, setGenerateTreeview, setGenerateXml, setGraphicalHierarchy, setGroupGraphs, setHaveDot, setHhcLocation, setHideFriendCompounds, setHideInBodyDocs, setHideScopeNames, setHideUndocClasses, setHideUndocMembers, setHideUndocRelations, setHtmlAlignMembers, setHtmlDynamicSections, setHtmlFileExtension, setHtmlFooter, setHtmlHeader, setHtmlOutput, setHtmlStylesheet, setIdlPropertySupport, setIgnorePrefix, setImagePath, setIncludedByGraph, setIncludeFilePatterns, setIncludeGraph, setIncludePath, setInheritDocs, setInlineInfo, setInlineInheritedMemb, setInlineSources, setInput, setInputEncoding, setInputFilter, setInternalDocs, setJavadocAutobrief, setLatexBatchmode, setLatexCmdName, setLatexHeader, setLatexHideIndices, setLatexOutput, setLayoutFile, setMacroExpansion, setMakeindexCmdName, setManExtension, setManLinks, setManOutput, setMaxDotGraphDepth, setMaxInitializerLines, setMscgenPath, setMultilineCppIsBrief, setOptimizeForFortran, setOptimizeOutputForC, setOptimizeOutputJava, setOptimizeOutputVhdl, setOutputLanguage, setPaperType, setPdfHyperlinks, setPerlmodLatex, setPerlmodMakevarPrefix, setPerlmodPretty, setPerlPath, setPredefined, setProjectName, setProjectNumber, setQchFile, setQhgLocation, setQhpNamespace, setQhpVirtualFolder, setQtAutobrief, setQuiet, setRecursive, setReferencedByRelation, setReferencesLinkSource, setReferencesRelation, setRepeatBrief, setRtfExtensionsFile, setRtfHyperlinks, setRtfOutput, setRtfStylesheetFile, setSearchengine, setSearchIncludes, setSeparateMemberPages, setShortNames, setShowDirectories, setShowFiles, setShowIncludeFiles, setShowNamespaces, setShowUsedFiles, setSipSupport, setSkipFunctionMacros, setSortBriefDocs, setSortByScopeName, setSortGroupNames, setSortMemberDocs, setSourceBrowser, setStripCodeComments, setStripFromIncPath, setStripFromPath, setSubgrouping, setSymbolCacheSize, setTabSize, setTagfiles, setTemplateRelations, setTocExpand, setTreeviewWidth, setTypedefHidesStruct, setUmlLook, setUseHtags, setUsePdflatex, setVerbatimHeaders, setWarnFormat, setWarnIfDocError, setWarnIfUndocumented, setWarnings, setWarnLogfile, setWarnNoParamdoc, setXmlDtd, setXmlOutput, setXmlProgramlisting, setXmlSchema

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

outputDirectory

@Parameter(property="doxygen.outputDirectory",
           defaultValue="${project.reporting.outputDirectory}")
private File outputDirectory

The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) base path where the generated documentation will be put. If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used.

executable

@Parameter(property="doxygen.executable",
           defaultValue="doxygen")
private String executable

This defines the name and/or the absolute path to he doxygen executable. Usually you shouldn't change this, cause the plugin will automatically search for the executable.

session

@Parameter(defaultValue="${session}",
           required=true,
           readonly=true)
private org.apache.maven.execution.MavenSession session

The current build session instance. This is used for toolchain manager API calls.

basedir

@Parameter(property="basedir",
           defaultValue="${project.basedir}",
           required=true,
           readonly=true)
private File basedir

This is the basedir.

skip

@Parameter(property="skip",
           defaultValue="false",
           required=true,
           readonly=true)
private boolean skip

This is the skip parameter to simply skip the doxygen generation part.

Constructor Detail

AbstractDoxygenMojo

public AbstractDoxygenMojo()

Method Detail

getOutputDirectory

protected File getOutputDirectory()

getToolchain

private org.apache.maven.toolchain.Toolchain getToolchain()

This code is lent from http://fisheye.codehaus.org/browse/~raw,r=8882/mojo/trunk/mojo/exec-maven-plugin/src/main/java/org/codehaus/mojo/ exec/ExecMojo.java

Returns:

Toolchain instance.

getExecutablePath

private String getExecutablePath()

This will check if the given information for the doxygen executable is enough. If not than we search on the path for doxygen executable.

Returns:

Path to the doxygen executable.

buildConfigurationFile

public File buildConfigurationFile()
                            throws org.apache.maven.reporting.MavenReportException

This method will get an existing configuration file for doxygen or will create a new one with the configured parameters.

Returns:

The configuration file.

Throws:

org.apache.maven.reporting.MavenReportException

buildConfigurationFile

public void buildConfigurationFile(File config)
                            throws org.apache.maven.reporting.MavenReportException

This method will create the configuration for calling doxygen. Furthermore is will put all configurable items into the configuration file.

Parameters:

config - The configuration.

Throws:

org.apache.maven.reporting.MavenReportException

addConfiguration

private void addConfiguration(PrintWriter config,
                    DoxygenParameters key,
                    boolean value)

This is called for boolean configuration items.

Parameters:

config - The configuration where to write to.

key - The configuration parameter name with it's default values etc.

value - The reals value, base on the Plugin configuration.

addConfiguration

private void addConfiguration(PrintWriter config,
                    DoxygenParameters key,
                    Integer value)

This is called for integer configuration items.

Parameters:

config - The configuration where to write to.

key - The configuration parameter name with it's default values etc.

value - The reals value, base on the Plugin configuration.

addConfiguration

private void addConfiguration(PrintWriter config,
                    DoxygenParameters key,
                    String value)

This is called for String configuration items.

Parameters:

config - The configuration where to write to.

key - The configuration parameter name with it's default values etc.

value - The reals value, base on the Plugin configuration.

addConfiguration

private void addConfiguration(PrintWriter config,
                    String desc,
                    String key,
                    String value)

This will write all kind of configuration items into the configuration file and will format the file.

Parameters:

config - The output file.

desc - The description of the item.

key - The name of the item

value - The value of the item.

executeReport

protected void executeReport(Locale unusedLocale)
                      throws org.apache.maven.reporting.MavenReportException

Parameters:

unusedLocale - the wanted locale (actually unused).

Throws:

org.apache.maven.reporting.MavenReportException - if any

setBasedir

public void setBasedir(File basedir)

getBasedir

public File getBasedir()

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

isSkip

public boolean isSkip()

setSkip

public void setSkip(boolean skip)