org.forgerock.doc.maven

Class PreProcessMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.forgerock.doc.maven.AbstractDocbkxMojo

org.forgerock.doc.maven.PreProcessMojo

All Implemented Interfaces:

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

@Mojo(name="process",
      defaultPhase=PRE_SITE)
public class PreProcessMojo
extends AbstractDocbkxMojo

Call other classes to pre-process documentation sources.

Nested Class Summary

Nested classes/interfaces inherited from class org.forgerock.doc.maven.AbstractDocbkxMojo

AbstractDocbkxMojo.Format, AbstractDocbkxMojo.ProfileAttributes

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PreProcessMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Call other classes to pre-process documentation sources.

Methods inherited from class org.forgerock.doc.maven.AbstractDocbkxMojo

areSectionsAutolabeled, doBuildReleaseZip, doCopyResourceFiles, doCreateArtifacts, doesSectionLabelIncludeComponentLabel, doOverwriteModifiableCopy, doOverwriteProjectFilesWithSharedContent, doUsePreProcessedSources, getArtifactItems, getAsciidocSourceDirectory, getAsciidoctorPluginVersion, getBackstageDirectory, getBackstageProductName, getBaseConfiguration, getBaseDir, getBootstrapCustomization, getBrandingArtifactId, getBrandingGroupId, getBrandingVersion, getBuildDirectory, getChunkedHTMLCustomization, getCommonContentArtifactId, getCommonContentGroupId, getCommonContentVersion, getDocbkxModifiableSourcesDirectory, getDocbkxOutputDirectory, getDocbkxSourceDirectory, getDocbkxVersion, getDocNames, getDocsSite, getDocumentSrcName, getDraftWatermarkURL, getEoslJson, getEpubCustomization, getExclusions, getFaviconLink, getFoCustomization, getFontsDirectory, getFopHyphVersion, getFopLogLevel, getFormats, getGoogleAnalyticsId, getInclusions, getJavaScriptFileName, getJCiteSourcePaths, getJCiteVersion, getLatestJson, getLinkTesterVersion, getLocaleTag, getManpagesCustomization, getMavenAssemblyVersion, getMavenDependencyVersion, getMavenFilteringVersion, getMavenResourcesVersion, getMaxImageHeightInInches, getPlantUmlVersion, getPlexusUtilsVersion, getPluginManager, getPreSiteCss, getProject, getProjectName, getProjectVersion, getRelativeResourcesDirectoryPath, getReleaseCss, getReleaseDate, getReleaseDirectory, getReleaseFaviconLink, getReleaseVersion, getReleaseVersionPath, getResourcesDirectory, getSession, getSingleHTMLCustomization, getSiteDirectory, getSkipUrlPatterns, getWebHelpCss, getWebHelpCustomization, getWebHelpLogo, getXCiteVersion, getXhtml5Customization, isDraftMode, isXincludeSupported, keepCustomIndexHtml, path, runLinkTester, skipLinkCheck, useAnsi, useSyntaxHighlighting

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

Constructor Detail

PreProcessMojo

public PreProcessMojo()

Method Detail

execute

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

Call other classes to pre-process documentation sources.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to process successfully.

org.apache.maven.plugin.MojoFailureException - Failed to process successfully.