javadoc package group declarations

[Stephen McConnell <mc...@apache.org>]

The javadoc task includes support for the intrduction of package group
declarations as shown in the following extract from the plugin.jelly:

   <j:forEach var="packageGroup" items="${pom.packageGroups}">
     <group title="${packageGroup.title}"
packages="${packageGroup.packages}"/>
   </j:forEach>

What I havn't figured out is where the package groups are declared.  It
appears that packagegroup is related to a <project/> (or is at least
associated to Project.getPackageGroups() ) however I havn't been able to
locate any documentation or hints in the code that suggest how package
groups should be declared.

Any help appreciated.

Cheers, Steve.

-- 

Stephen J. McConnell
mailto:mcconnell@apache.org
http://www.osm.net

Re: javadoc package group declarations

[Stephen McConnell <mc...@apache.org>]

Stephen McConnell wrote:

>
> The javadoc task includes support for the intrduction of package group
> declarations as shown in the following extract from the plugin.jelly:
>
>   <j:forEach var="packageGroup" items="${pom.packageGroups}">
>     <group title="${packageGroup.title}"
> packages="${packageGroup.packages}"/>
>   </j:forEach>
>
> What I havn't figured out is where the package groups are declared.  It
> appears that packagegroup is related to a <project/> (or is at least
> associated to Project.getPackageGroups() ) however I havn't been able to
> locate any documentation or hints in the code that suggest how package
> groups should be declared.


Here I go answering my own email!

<project>

  <!-- other project stuff -->

  <packageGroups>
    <packageGroup>
      <title>My Fist Package Group</title>
      <packages>a.b.c,x.y.z</packages>
    </packageGroup>
    <packageGroup>
      <title>Another Package Group</title>
      <packages>aaaa.bbb,aaa.bbb.*</packages>
    </packageGroup>
  </packageGroups>

</project>

Cheers, Steve.

>
> Any help appreciated.
>
> Cheers, Steve.
>

-- 

Stephen J. McConnell
mailto:mcconnell@apache.org
http://www.osm.net