You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Indrajit Raychaudhuri (JIRA)" <ji...@codehaus.org> on 2005/08/06 09:59:57 UTC

[jira] Created: (MNG-704) javadoc plugin doesn't honor multiple custom tags

javadoc plugin doesn't honor multiple custom tags
-------------------------------------------------

         Key: MNG-704
         URL: http://jira.codehaus.org/browse/MNG-704
     Project: Maven 2
        Type: Bug
  Components: maven-plugins  
    Versions: 2.0-alpha-3    
 Reporter: Indrajit Raychaudhuri


M2 javaodc plugin doesn't honor multiple tag as it did with M1.

In M1 we could specify this in project.properties:

maven.javadoc.customtags = usage todo fixme

usage.name = .usage
usage.description = Usage:
usage.enabled = true
usage.scope = all

todo.name = .todo
todo.description = Todo:
todo.enabled = false
todo.scope = all

fixme.name = .fixme
fixme.description = Fixme:
fixme.enabled = false
fixme.scope = all

However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.


-- 
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: (MNG-704) javadoc plugin doesn't honor multiple custom tags

Posted by "Indrajit Raychaudhuri (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MNG-704?page=comments#action_47318 ] 

Indrajit Raychaudhuri commented on MNG-704:
-------------------------------------------

I had tried <tag>.usage:a:Usage:, .todo:a:To do something:, .fixme:a:Fixme:</tag> before posting the issue but didn't get it to work (maybe I missed the white-spaces in-between :)).

It works M2-beta-1 onwards and should serve the purpose.

However, having provision to describe each tag separately would make it consistent (can be deferred to 2.1).


> javadoc plugin doesn't honor multiple custom tags
> -------------------------------------------------
>
>          Key: MNG-704
>          URL: http://jira.codehaus.org/browse/MNG-704
>      Project: Maven 2
>         Type: Bug
>   Components: maven-javadoc-plugin
>     Versions: 2.0-alpha-3
>     Reporter: Indrajit Raychaudhuri
>     Assignee: Vincent Siveton
>     Priority: Minor
>      Fix For: 2.0-beta-4

>
>
> M2 javaodc plugin doesn't honor multiple tag as it did with M1.
> In M1 we could specify this in project.properties:
> maven.javadoc.customtags = usage todo fixme
> usage.name = .usage
> usage.description = Usage:
> usage.enabled = true
> usage.scope = all
> todo.name = .todo
> todo.description = Todo:
> todo.enabled = false
> todo.scope = all
> fixme.name = .fixme
> fixme.description = Fixme:
> fixme.enabled = false
> fixme.scope = all
> However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.

-- 
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: (MNG-704) javadoc plugin doesn't honor multiple custom tags

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

Brett Porter updated MNG-704:
-----------------------------

    Component:     (was: maven-plugins)
               maven-javadoc-plugin

> javadoc plugin doesn't honor multiple custom tags
> -------------------------------------------------
>
>          Key: MNG-704
>          URL: http://jira.codehaus.org/browse/MNG-704
>      Project: Maven 2
>         Type: Bug
>   Components: maven-javadoc-plugin
>     Versions: 2.0-alpha-3
>     Reporter: Indrajit Raychaudhuri
>     Assignee: Vincent Siveton
>      Fix For: 2.0-rc1

>
>
> M2 javaodc plugin doesn't honor multiple tag as it did with M1.
> In M1 we could specify this in project.properties:
> maven.javadoc.customtags = usage todo fixme
> usage.name = .usage
> usage.description = Usage:
> usage.enabled = true
> usage.scope = all
> todo.name = .todo
> todo.description = Todo:
> todo.enabled = false
> todo.scope = all
> fixme.name = .fixme
> fixme.description = Fixme:
> fixme.enabled = false
> fixme.scope = all
> However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.

-- 
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: (MNG-704) javadoc plugin doesn't honor multiple custom tags

Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MNG-704?page=comments#action_44051 ] 

Vincent Siveton commented on MNG-704:
-------------------------------------

The plugin tag option is a comma separated of Javadoc tag options: 
http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag

Thus, the following configuration should work:
<tag>.usage:a:Usage:, .todo:a:To do something:, .fixme:a:Fixme:</tag>

Do you think that it should be better to describe each tag in sub properties or to use Javadoc tag definition?


> javadoc plugin doesn't honor multiple custom tags
> -------------------------------------------------
>
>          Key: MNG-704
>          URL: http://jira.codehaus.org/browse/MNG-704
>      Project: Maven 2
>         Type: Bug
>   Components: maven-plugins
>     Versions: 2.0-alpha-3
>     Reporter: Indrajit Raychaudhuri
>     Assignee: Vincent Siveton

>
>
> M2 javaodc plugin doesn't honor multiple tag as it did with M1.
> In M1 we could specify this in project.properties:
> maven.javadoc.customtags = usage todo fixme
> usage.name = .usage
> usage.description = Usage:
> usage.enabled = true
> usage.scope = all
> todo.name = .todo
> todo.description = Todo:
> todo.enabled = false
> todo.scope = all
> fixme.name = .fixme
> fixme.description = Fixme:
> fixme.enabled = false
> fixme.scope = all
> However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.

-- 
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: (MNG-704) javadoc plugin doesn't honor multiple custom tags

Posted by "John Casey (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-704?page=all ]
     
John Casey closed MNG-704:
--------------------------

    Resolution: Fixed

the javadoc plugin now supports both the old config option of: 

<tag>one, two, three</tag>

AND the new list-oriented syntax:

<tags>
  <tag>one</tag>
  <tag>two</tag>
  <tag>three</tag>
</tags>

> javadoc plugin doesn't honor multiple custom tags
> -------------------------------------------------
>
>          Key: MNG-704
>          URL: http://jira.codehaus.org/browse/MNG-704
>      Project: Maven 2
>         Type: Bug
>   Components: maven-javadoc-plugin
>     Versions: 2.0-alpha-3
>     Reporter: Indrajit Raychaudhuri
>     Assignee: John Casey
>     Priority: Minor
>      Fix For: 2.0-beta-4

>
> Original Estimate: 30 minutes
>        Time Spent: 30 minutes
>         Remaining: 0 minutes
>
> M2 javaodc plugin doesn't honor multiple tag as it did with M1.
> In M1 we could specify this in project.properties:
> maven.javadoc.customtags = usage todo fixme
> usage.name = .usage
> usage.description = Usage:
> usage.enabled = true
> usage.scope = all
> todo.name = .todo
> todo.description = Todo:
> todo.enabled = false
> todo.scope = all
> fixme.name = .fixme
> fixme.description = Fixme:
> fixme.enabled = false
> fixme.scope = all
> However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.

-- 
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: (MNG-704) javadoc plugin doesn't honor multiple custom tags

Posted by "John Casey (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-704?page=all ]

John Casey updated MNG-704:
---------------------------

            Complexity: Intermediate
    Remaining Estimate: 30 minutes
     Original Estimate: 1800

will convert to list format.

> javadoc plugin doesn't honor multiple custom tags
> -------------------------------------------------
>
>          Key: MNG-704
>          URL: http://jira.codehaus.org/browse/MNG-704
>      Project: Maven 2
>         Type: Bug
>   Components: maven-javadoc-plugin
>     Versions: 2.0-alpha-3
>     Reporter: Indrajit Raychaudhuri
>     Assignee: John Casey
>     Priority: Minor
>      Fix For: 2.0-beta-4

>
> Original Estimate: 30 minutes
>         Remaining: 30 minutes
>
> M2 javaodc plugin doesn't honor multiple tag as it did with M1.
> In M1 we could specify this in project.properties:
> maven.javadoc.customtags = usage todo fixme
> usage.name = .usage
> usage.description = Usage:
> usage.enabled = true
> usage.scope = all
> todo.name = .todo
> todo.description = Todo:
> todo.enabled = false
> todo.scope = all
> fixme.name = .fixme
> fixme.description = Fixme:
> fixme.enabled = false
> fixme.scope = all
> However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.

-- 
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: (MNG-704) javadoc plugin doesn't honor multiple custom tags

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

Brett Porter updated MNG-704:
-----------------------------

    Fix Version: 2.0-rc1

> javadoc plugin doesn't honor multiple custom tags
> -------------------------------------------------
>
>          Key: MNG-704
>          URL: http://jira.codehaus.org/browse/MNG-704
>      Project: Maven 2
>         Type: Bug
>   Components: maven-plugins
>     Versions: 2.0-alpha-3
>     Reporter: Indrajit Raychaudhuri
>     Assignee: Vincent Siveton
>      Fix For: 2.0-rc1

>
>
> M2 javaodc plugin doesn't honor multiple tag as it did with M1.
> In M1 we could specify this in project.properties:
> maven.javadoc.customtags = usage todo fixme
> usage.name = .usage
> usage.description = Usage:
> usage.enabled = true
> usage.scope = all
> todo.name = .todo
> todo.description = Todo:
> todo.enabled = false
> todo.scope = all
> fixme.name = .fixme
> fixme.description = Fixme:
> fixme.enabled = false
> fixme.scope = all
> However, in M2 the putting the <tag/> switch isn't honor multiple times. Only the last one get passed to the javadoc -tag switch.

-- 
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