[MJAVADOC-814] Ability to split grouped packages over multiple lines

[jira-importer]

Richard Eckart de Castilho opened MJAVADOC-814 and commented

When configuring groups, the packages in the group need to be written on a single line separated with colons.

<groups>
  <group>
    <title>Core</title>
    <packages>
      org.apache.uima.analysis_component:org.apache.uima.analysis_engine
    </packages>
  </group>
</groups>

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

<groups>
  <group>
    <title>Core</title>
    <packages>
      org.apache.uima.analysis_component:
      org.apache.uima.analysis_engine
    </packages>
  </group>
</groups>

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.

<groups>
  <group>
    <title>Core</title>
    <packages>
      <package>org.apache.uima.analysis_component</package>
      <package>org.apache.uima.analysis_engine</package>
    </packages>
  </group>
</groups>

---

Affects: 3.10.0

Remote Links:

• GitHub Pull Request #337
  

[jira-importer]

Michael Osipov commented

I believe that implementing this will be incomplete because the same issue applies to these as well:

• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#docletPath
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#bootclasspath
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludedocfilessubdir
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#extdirs
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#sourcepath
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#subpackages
• https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#tagletpath

[jira-importer]

Olivier Lamy commented

done