Skip to content

[MPLUGIN-536] Allow generation of documentation for nested POJOs used as @Parameters #846

@jira-importer

Description

@jira-importer

Ashley Scopes opened MPLUGIN-536 and commented

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.


No further details from MPLUGIN-536

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestpriority:minorMinor loss of function, or other problem where easy workaround is present

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions