You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Allison, Bob" <ro...@qwest.com> on 2006/03/17 11:57:29 UTC

Comment About Plugin Parameter Documentation

I was looking at the commit of r386543 which added a couple parameters
to the javadoc plugin for selecting classes based on package.  The
Javadoc for the two parameters reads:
   /**
    * Specifies the source path where the subpackages are located.
    *
    * @parameter expression="${sourcepath}"
    */
   private String sourcepath;

   /**
    * Specifies the package directory where javadoc will be executed.
    *
    * @parameter expression="${subpackages}"
    */
   private String subpackages;

These parameters are split in the code to make individual path elements
and package names.  It would be REAL nice if the documentation for
parameters like these included what characters are used to split the
string.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: Comment About Plugin Parameter Documentation

Posted by Brett Porter <br...@apache.org>.
Good eye - fixed. Thanks!

- Brett

Allison, Bob wrote:
> I was looking at the commit of r386543 which added a couple parameters
> to the javadoc plugin for selecting classes based on package.  The
> Javadoc for the two parameters reads:
>    /**
>     * Specifies the source path where the subpackages are located.
>     *
>     * @parameter expression="${sourcepath}"
>     */
>    private String sourcepath;
> 
>    /**
>     * Specifies the package directory where javadoc will be executed.
>     *
>     * @parameter expression="${subpackages}"
>     */
>    private String subpackages;
> 
> These parameters are split in the code to make individual path elements
> and package names.  It would be REAL nice if the documentation for
> parameters like these included what characters are used to split the
> string.
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
> 

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org