com.soebes.maven.plugins.doxygen

Class DoxygenReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.soebes.maven.plugins.doxygen.AbstractDoxygenConfigurationMojo

com.soebes.maven.plugins.doxygen.AbstractDoxygenMojo

com.soebes.maven.plugins.doxygen.DoxygenReport

All Implemented Interfaces:

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

@Mojo(name="report",
      defaultPhase=SITE,
      requiresProject=true,
      threadSafe=true)
public class DoxygenReport
extends AbstractDoxygenMojo
implements org.apache.maven.reporting.MavenReport

This part will create the report.

Field Summary

Fields

Modifier and Type	Field and Description
private String	destDir The name of the destination directory.
private File	reportOutputDirectory Specifies the destination directory where javadoc saves the generated HTML files.
private org.apache.maven.doxia.siterenderer.Renderer	siteRenderer

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DoxygenReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	execute()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getDestDir()
String	getName(Locale locale)
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setDestDir(String destDir)
void	setReportOutputDirectory(File reportOutputDirectory)

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

buildConfigurationFile, buildConfigurationFile, executeReport, getBasedir, getOutputDirectory, isSkip, setBasedir, setOutputDirectory, setSkip

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

Field Detail

siteRenderer

@Component
private org.apache.maven.doxia.siterenderer.Renderer siteRenderer

reportOutputDirectory

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

Specifies the destination directory where javadoc saves the generated HTML files.

destDir

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

The name of the destination directory.

Constructor Detail

DoxygenReport

public DoxygenReport()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
            Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getProject

protected org.apache.maven.project.MavenProject getProject()

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

setDestDir

public void setDestDir(String destDir)

getDestDir

public String getDestDir()

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport