Class PluginHelpGenerator

  • All Implemented Interfaces:
    Generator, org.codehaus.plexus.logging.LogEnabled

    public class PluginHelpGenerator
    extends org.codehaus.plexus.logging.AbstractLogEnabled
    implements Generator
    Generates an HelpMojo class from help-class-source.vm template. The generated mojo reads help content from META-INF/maven/${groupId}/${artifactId}/plugin-help.xml resource, which is generated by this PluginDescriptorGenerator.

    Notice that the help mojo source needs to be generated before compilation, but when Java annotations are used, plugin descriptor content is available only after compilation (detecting annotations in .class files): help mojo source can be generated with empty package only (and no plugin descriptor available yet), then needs to be updated after compilation - through rewriteHelpMojo(PluginToolsRequest, Log) which is called from plugin descriptor XML generation.

    Since:
    2.4
    Author:
    Vincent Siveton
    • Constructor Detail

      • PluginHelpGenerator

        public PluginHelpGenerator()
        Default constructor
    • Method Detail

      • getVelocityComponent

        public org.codehaus.plexus.velocity.VelocityComponent getVelocityComponent()
      • setVelocityComponent

        public PluginHelpGenerator setVelocityComponent​(org.codehaus.plexus.velocity.VelocityComponent velocityComponent)