You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Martin Desruisseaux (JIRA)" <ji...@codehaus.org> on 2005/10/10 10:36:11 UTC

[jira] Created: (MNG-1154) parameter seems hard to use

<group> parameter seems hard to use
-----------------------------------

         Key: MNG-1154
         URL: http://jira.codehaus.org/browse/MNG-1154
     Project: Maven 2
        Type: Bug
  Components: maven-javadoc-plugin  
    Versions: 2.0-beta-3    
 Environment: Windows XP
 Reporter: Martin Desruisseaux
    Priority: Minor


The <group> parameter is a comma-separated list. A looks into the source code suggest that the plugin uses StringTokenizer for splitting the String around comas, no matter if the coma were inside quotes or not. Next, the tokens are put between quotes if they contains spaces. This means that the following parameter:

  <group>
      Feature Geometry   org.geotools.geometry*
  </group>

is translated into the following javadoc options:

    -group "Feature Geometry   org.geotools.geometry*"

when it should has been:

    -group "Feature Geometry"   "org.geotools.geometry*"

Putting "Feature Geometry" between quotes in the <group> parameter doesn't help (it produces an other unexpected result). We really need a space between the title and the packages; it is part of javadoc tools specification, and current maven-javadoc-plugin seems to prevent that.

Furthermore, because of the coma-delimited nature of the <group> argument, we can't put coma in group title.

I would like to suggest to replace the current <group> parameter syntax by the same one than Ant:

  <group title="Feature Geometry" packages="org.geotools.geometry*"/>


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


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


[jira] Updated: (MJAVADOC-8) parameter seems hard to use

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MJAVADOC-8?page=all ]

Brett Porter updated MJAVADOC-8:
--------------------------------

    Fix Version: 2.0

> <group> parameter seems hard to use
> -----------------------------------
>
>          Key: MJAVADOC-8
>          URL: http://jira.codehaus.org/browse/MJAVADOC-8
>      Project: Maven 2.x Javadoc Plugin
>         Type: Bug

>  Environment: Windows XP
>     Reporter: Martin Desruisseaux
>     Priority: Minor
>      Fix For: 2.0

>
>
> The <group> parameter is a comma-separated list. A looks into the source code suggest that the plugin uses StringTokenizer for splitting the String around comas, no matter if the coma were inside quotes or not. Next, the tokens are put between quotes if they contains spaces. This means that the following parameter:
>   <group>
>       Feature Geometry   org.geotools.geometry*
>   </group>
> is translated into the following javadoc options:
>     -group "Feature Geometry   org.geotools.geometry*"
> when it should has been:
>     -group "Feature Geometry"   "org.geotools.geometry*"
> Putting "Feature Geometry" between quotes in the <group> parameter doesn't help (it produces an other unexpected result). We really need a space between the title and the packages; it is part of javadoc tools specification, and current maven-javadoc-plugin seems to prevent that.
> Furthermore, because of the coma-delimited nature of the <group> argument, we can't put coma in group title.
> I would like to suggest to replace the current <group> parameter syntax by the same one than Ant:
>   <group title="Feature Geometry" packages="org.geotools.geometry*"/>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


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


[jira] Commented: (MJAVADOC-8) parameter seems hard to use

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MJAVADOC-8?page=comments#action_59611 ] 

Brett Porter commented on MJAVADOC-8:
-------------------------------------

should probably be:
<groups>
<group>
 <title>...</title>
 <packages>...</packages>
</group>
...
</groups>

> <group> parameter seems hard to use
> -----------------------------------
>
>          Key: MJAVADOC-8
>          URL: http://jira.codehaus.org/browse/MJAVADOC-8
>      Project: Maven 2.x Javadoc Plugin
>         Type: Bug

>  Environment: Windows XP
>     Reporter: Martin Desruisseaux
>     Priority: Minor

>
>
> The <group> parameter is a comma-separated list. A looks into the source code suggest that the plugin uses StringTokenizer for splitting the String around comas, no matter if the coma were inside quotes or not. Next, the tokens are put between quotes if they contains spaces. This means that the following parameter:
>   <group>
>       Feature Geometry   org.geotools.geometry*
>   </group>
> is translated into the following javadoc options:
>     -group "Feature Geometry   org.geotools.geometry*"
> when it should has been:
>     -group "Feature Geometry"   "org.geotools.geometry*"
> Putting "Feature Geometry" between quotes in the <group> parameter doesn't help (it produces an other unexpected result). We really need a space between the title and the packages; it is part of javadoc tools specification, and current maven-javadoc-plugin seems to prevent that.
> Furthermore, because of the coma-delimited nature of the <group> argument, we can't put coma in group title.
> I would like to suggest to replace the current <group> parameter syntax by the same one than Ant:
>   <group title="Feature Geometry" packages="org.geotools.geometry*"/>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


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


[jira] Closed: (MJAVADOC-8) parameter seems hard to use

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MJAVADOC-8?page=all ]
     
Vincent Siveton closed MJAVADOC-8:
----------------------------------

     Assign To: Vincent Siveton
    Resolution: Fixed

Brett's proposal applied in SVN

> <group> parameter seems hard to use
> -----------------------------------
>
>          Key: MJAVADOC-8
>          URL: http://jira.codehaus.org/browse/MJAVADOC-8
>      Project: Maven 2.x Javadoc Plugin
>         Type: Bug

>  Environment: Windows XP
>     Reporter: Martin Desruisseaux
>     Assignee: Vincent Siveton
>     Priority: Minor
>      Fix For: 2.0

>
>
> The <group> parameter is a comma-separated list. A looks into the source code suggest that the plugin uses StringTokenizer for splitting the String around comas, no matter if the coma were inside quotes or not. Next, the tokens are put between quotes if they contains spaces. This means that the following parameter:
>   <group>
>       Feature Geometry   org.geotools.geometry*
>   </group>
> is translated into the following javadoc options:
>     -group "Feature Geometry   org.geotools.geometry*"
> when it should has been:
>     -group "Feature Geometry"   "org.geotools.geometry*"
> Putting "Feature Geometry" between quotes in the <group> parameter doesn't help (it produces an other unexpected result). We really need a space between the title and the packages; it is part of javadoc tools specification, and current maven-javadoc-plugin seems to prevent that.
> Furthermore, because of the coma-delimited nature of the <group> argument, we can't put coma in group title.
> I would like to suggest to replace the current <group> parameter syntax by the same one than Ant:
>   <group title="Feature Geometry" packages="org.geotools.geometry*"/>

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


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