OpenDJ Doc Helper Maven Plugin Helps to build generated documentation sources. org.forgerock.opendj opendj-doc-maven-plugin 3.0.0-SNAPSHOT opendj-doc false true generate-schema-ref Generate schema-related reference documentation sources. false true false false false true org.forgerock.opendj.maven.doc.GenerateSchemaDocMojo java per-lookup once-per-session false locale java.lang.String false true The locale for which to generate the documentation. outputDirectory java.io.File false true Output directory for source files. generate-refentry Generate DocBook RefEntry source documents for command-line tools man pages. compile+runtime false true false false false true prepare-package org.forgerock.opendj.maven.doc.GenerateRefEntriesMojo java per-lookup once-per-session false outputDir java.io.File true true Where to write the RefEntry files. project org.apache.maven.project.MavenProject true false The Maven Project. tools java.util.List false true Tools for which to generate RefEntry files. ${project} generate-xml-messages-doc Generates an XML file of log messages found in properties files. false true false false false true pre-site org.forgerock.opendj.maven.doc.GenerateMessageFileMojo java per-lookup once-per-session false locale java.lang.String false true The tag of the locale for which to generate the documentation. messageFileNames java.util.List true true A list which contains all file names, the extension is not needed. messagesDirectory java.lang.String true true The path to the directory containing the message properties files. outputDirectory java.lang.String true true The path to the directory where the XML file should be written. This path must be relative to ${project.build.directory}. project org.apache.maven.project.MavenProject true false The Maven Project. ${project} generate-global-acis-table Generates documentation source table listing global ACIs. false true false false false true org.forgerock.opendj.maven.doc.GenerateGlobalAcisTableMojo java per-lookup once-per-session false configDotLdif java.io.File false true The config.ldif file containing default global ACIs. * locale java.lang.String false true The locale for which to generate the documentation. outputDirectory java.io.File false true Output directory for source files. generate-result-code-doc Generates documentation source for LDAP result codes based on {@code org.forgerock.opendj.ldap.ResultCode}. <br> This implementation parses the source to match Javadoc comments with result codes. It is assumed that the class's ResultCode fields are named with result code enum values, and that those fields have Javadoc comments describing each result code. false true false false false true compile org.forgerock.opendj.maven.doc.GenerateResultCodeDocMojo java per-lookup once-per-session false resultCodeSource java.io.File true true The Java file containing the source of the ResultCode class, {@code org.forgerock.opendj.ldap.ResultCode}. <br> For example, {@code opendj-core/src/main/java/org/forgerock/opendj/ldap/ResultCode.java}. xmlFile java.io.File true true The XML file to generate. generate-config-ref Generates the configuration reference, a set of HTML documents describing the server configuration. false true false false false true pre-site org.forgerock.opendj.maven.doc.GenerateConfigurationReferenceMojo java per-lookup once-per-session false outputDirectory java.lang.String false true The path to the directory where the configuration reference should be written. This path must be under {@code ${project.build.directory} }. project org.apache.maven.project.MavenProject true false The Maven Project. ${project} org.forgerock.opendj opendj-core jar 3.0.0-SNAPSHOT org.slf4j slf4j-api jar 1.7.5 org.forgerock.commons forgerock-util jar 2.0.0-20150825.212318-40 org.forgerock.commons i18n-slf4j jar 1.4.2-20140131.143158-9 org.forgerock.commons i18n-core jar 1.4.2-20140131.143158-9 org.freemarker freemarker jar 2.3.21 org.twdata.maven mojo-executor jar 2.2.0 org.apache.maven maven-core jar 3.0 org.apache.maven maven-settings jar 3.0 org.apache.maven maven-settings-builder jar 3.0 org.apache.maven maven-repository-metadata jar 3.0 org.apache.maven maven-model-builder jar 3.0 org.apache.maven maven-aether-provider jar 3.0 org.sonatype.aether aether-impl jar 1.7 org.sonatype.aether aether-spi jar 1.7 org.sonatype.aether aether-api jar 1.7 org.sonatype.aether aether-util jar 1.7 org.sonatype.sisu sisu-inject-plexus jar 1.4.2 org.sonatype.sisu sisu-inject-bean jar 1.4.2 org.sonatype.sisu sisu-guice jar 2.1.7 org.codehaus.plexus plexus-interpolation jar 1.14 org.codehaus.plexus plexus-classworlds jar 2.2.3 org.codehaus.plexus plexus-component-annotations jar 1.5.5 org.sonatype.plexus plexus-sec-dispatcher jar 1.3 org.sonatype.plexus plexus-cipher jar 1.4 org.apache.maven maven-model jar 3.0 org.apache.maven maven-plugin-api jar 3.0 org.codehaus.plexus plexus-utils jar 1.5.1 com.thoughtworks.qdox qdox jar 2.0-M3 org.apache.maven maven-artifact jar 3.0