Uploaded image for project: 'Maven Plugin Tools'
  1. Maven Plugin Tools
  2. MPLUGIN-536

Allow generation of documentation for nested POJOs used as @Parameters

    XMLWordPrintableJSON

Details

    Description

      As a plugin developer of a plugin with a few dozen complex options, I'd like to see a new feature where by the generated site documentation and help mojo document the fields of nested pojos that are present with javadoc comments.

        @Parameter
        private Thing thing;
      
      public class Thing {
        public Foo getFoo() { ... }
        public void setFoo(Foo foo) { ... }
      }
      

      Currently the plugins just report the fully qualified class name as a dead link, which means nested attributes have to be documented manually and the consistency of this varies wildly between projects.

      I'd either like to see the ability for the documentation to be generated from project sources, dependency sources, or JavaDoc JARs, or the ability to provide a custom @Documentation annotation to document attributes in nested objects.

      This could be specified within a "schemas" section at the bottom of the goal HTML page.

      Attachments

        Activity

          People

            Unassigned Unassigned
            ascopes Ashley Scopes
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: