apache / apache/maven-plugin-tools

[MPLUGIN-308] Improve mojo documentation for "plugin:report" on complex parameter types

Open
#617 2 comments 0 reactions 0 assignees View on GitHub
enhancement priority:major
Dominant language
Java
Stars
64
Forks
71
Avg merge
12h 24m
Merged PRs (30d)
32

Description

**[Konrad Windszus](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=kwin)** opened **[MPLUGIN-308](https://issues.apache.org/jira/browse/MPLUGIN-308?redirect=false)** and commented

In case you have a Mojo with a custom complex parameter, i.e. a Parameter of type `MyParam`, where `MyParam` again has some fields annotated with `@Parameter`, the documentation of `MyParam` with its individual pieces should be part of the mojo documentation being generated by `plugin:report`.
See also http://stackoverflow.com/questions/20696862/inject-parameter-in-different-class-in-maven-plugin.

---

**Affects:** 3.4

**Issue Links:**
- [MPLUGIN-317](https://issues.apache.org/jira/browse/MPLUGIN-317) generate documentation for complex types
(_**"is duplicated by"**_)
- [MPLUGIN-9](https://issues.apache.org/jira/browse/MPLUGIN-9) Add link to javadoc in configuration description page for user defined types of Mojos.

1 votes, 4 watchers

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.