/poblano

Maven Configuration Documentation Generator

Primary LanguageJava

Poblano - Maven Configuration Documentation Generation

This little Annotation Processor helps in generation documentation for the configuration of a Maven Plugin.

Caution
 This is work-in-progress and doesn’t do much yet. Stay tuned …​.

The annotation processor detects configuration annotated with @Parameter and extracts the JavaDoc attached to this configuration variable:

Example Documentation
@Mojo(name = "MyMojo")
public class MyMojo extends AbstractMojo {
   // .....

   /**
    * If set to true print <em>verbose</em> progress messages
    */
   @Parameter(defaultValue = false)
   private boolean verbose;

  // ......
}

As output formats will be created:

  • XML Schema which can be included used in a decent IDE for autocompletion.

  • AsciiDoc Snippets which can be used in reference Manuals for direct inclusion.