[
https://issues.apache.org/jira/browse/MJAVADOC-814?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17898857#comment-17898857
]
ASF GitHub Bot commented on MJAVADOC-814:
-----------------------------------------
olamy opened a new pull request, #337:
URL: https://github.com/apache/maven-javadoc-plugin/pull/337
Signed-off-by: Olivier Lamy <[email protected]>
Following this checklist to help us incorporate your
contribution quickly and easily:
- [ ] Make sure there is a [JIRA
issue](https://issues.apache.org/jira/browse/MJAVADOC) filed
for the change (usually before you start working on it). Trivial
changes like typos do not
require a JIRA issue. Your pull request should address just this
issue, without
pulling in other changes.
- [ ] Each commit in the pull request should have a meaningful subject line
and body.
- [ ] Format the pull request title like `[MJAVADOC-XXX] - Fixes bug in
ApproximateQuantiles`,
where you replace `MJAVADOC-XXX` with the appropriate JIRA issue.
Best practice
is to use the JIRA issue title in the pull request title and in the
first line of the
commit message.
- [ ] Write a pull request description that is detailed enough to
understand what the pull request does, how, and why.
- [ ] Run `mvn clean verify -Prun-its` to make sure basic checks pass. A
more thorough check will
be performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [ ] I hereby declare this contribution to be licensed under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
> Ability to split grouped packages over multiple lines
> -----------------------------------------------------
>
> Key: MJAVADOC-814
> URL: https://issues.apache.org/jira/browse/MJAVADOC-814
> Project: Maven Javadoc Plugin
> Issue Type: New Feature
> Components: javadoc
> Affects Versions: 3.10.0
> Reporter: Richard Eckart de Castilho
> Assignee: Olivier Lamy
> Priority: Major
>
> When configuring groups, the packages in the group need to be written on a
> single line separated with colons.
> {noformat}
> <groups>
> <group>
> <title>Core</title>
> <packages>
> org.apache.uima.analysis_component:org.apache.uima.analysis_engine
> </packages>
> </group>
> </groups>
> {noformat}
> If there are many packages that can not easily be captured using a prefix
> pattern, this yields a very long line.
> It would be greate if one could split the packages over multiple lines such as
> {noformat}
> <groups>
> <group>
> <title>Core</title>
> <packages>
> org.apache.uima.analysis_component:
> org.apache.uima.analysis_engine
> </packages>
> </group>
> </groups>
> {noformat}
> The code internally already calls
> {{org.apache.maven.plugins.javadoc.JavadocUtil.quotedArgument(String)}} to
> sanitze the line breaks away, but it seems the whitespace still breaks it and
> javadoc tool in the end only recognizes the first package in the multi-line
> group.
> Even nicer may be.
> {noformat}
> <groups>
> <group>
> <title>Core</title>
> <packages>
> <package>org.apache.uima.analysis_component</package>
> <package>org.apache.uima.analysis_engine</package>
> </packages>
> </group>
> </groups>
> {noformat}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
