Class ModelloXdocMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    @Mojo(name="xdoc",
          threadSafe=true)
    public class ModelloXdocMojo
    extends AbstractModelloGeneratorMojo
    Creates documentation for the model in xdoc format.
    • Field Detail

      • outputDirectory

        @Parameter(defaultValue="${project.build.directory}/generated-site/xdoc",
                   required=true)
        private java.io.File outputDirectory
        The output directory of the generated documentation.
      • xdocFileName

        @Parameter
        private java.lang.String xdocFileName
        Since:
        1.0-alpha-21
      • firstVersion

        @Parameter
        private java.lang.String firstVersion
        The first version of the model. This is used to decide whether or not to show the since column. If this is not specified, it defaults to the version of the model, which in turn means that the since column will not be shown.
        Since:
        1.0-alpha-14
    • Constructor Detail

      • ModelloXdocMojo

        public ModelloXdocMojo()
    • Method Detail

      • setOutputDirectory

        public void setOutputDirectory​(java.io.File outputDirectory)
      • customizeParameters

        protected void customizeParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Description copied from class: AbstractModelloGeneratorMojo
        Override this method to customize the values in the properties set.

        This method will be called after the parameters have been populated with the parameters in the abstract mojo.

        Overrides:
        customizeParameters in class AbstractModelloGeneratorMojo
        Parameters:
        parameters - the parameters to customize
      • getFirstVersion

        public java.lang.String getFirstVersion()
      • setFirstVersion

        public void setFirstVersion​(java.lang.String firstVersion)