You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@xalan.apache.org by "Sarah McNamara (JIRA)" <xa...@xml.apache.org> on 2005/01/23 01:04:17 UTC

[jira] Created: (XALANJ-2048) Cleanup of javadoc to reduce the number of warnings during doc builds

Cleanup of javadoc to reduce the number of warnings during doc builds
---------------------------------------------------------------------

         Key: XALANJ-2048
         URL: http://issues.apache.org/jira/browse/XALANJ-2048
     Project: XalanJ2
        Type: Bug
  Components: Xalan  
    Versions: CurrentCVS    
    Reporter: Sarah McNamara
 Assigned to: Sarah McNamara 
    Priority: Minor
     Fix For: CurrentCVS


Although we can successfully build the api documentation, there are quite a number of warnings issued during the javadoc build.  Inspection of the code reveals that we have many @param tags that contain incorrectly spelled or non-existent parameters in the method signatures.  

The javadoc really needs a complete overall at some point to correct/update the descriptions of methods, parameters, return values, exceptions, etc.   This bug report is not intended to address is larger issue.   For now, the cleanup to reduce the number of warnings is all that is intended.




-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira


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


[jira] Updated: (XALANJ-2048) Cleanup of javadoc to reduce the number of warnings during doc builds

Posted by "Brian Minchau (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2048?page=history ]

Brian Minchau updated XALANJ-2048:
----------------------------------

    Xalan-keywords: fp4

Fix priority 4, fp4 set in Xalan-keywords field, per bug triage of Feb 1, 2005.

> Cleanup of javadoc to reduce the number of warnings during doc builds
> ---------------------------------------------------------------------
>
>          Key: XALANJ-2048
>          URL: http://issues.apache.org/jira/browse/XALANJ-2048
>      Project: XalanJ2
>         Type: Bug
>   Components: Xalan
>     Versions: CurrentCVS
>     Reporter: Sarah McNamara
>     Assignee: Sarah McNamara
>     Priority: Minor
>      Fix For: CurrentCVS

>
> Although we can successfully build the api documentation, there are quite a number of warnings issued during the javadoc build.  Inspection of the code reveals that we have many @param tags that contain incorrectly spelled or non-existent parameters in the method signatures.  
> The javadoc really needs a complete overall at some point to correct/update the descriptions of methods, parameters, return values, exceptions, etc.   This bug report is not intended to address is larger issue.   For now, the cleanup to reduce the number of warnings is all that is intended.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira


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


[jira] Closed: (XALANJ-2048) Cleanup of javadoc to reduce the number of warnings during doc builds

Posted by "Sarah McNamara (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2048?page=all ]
     
Sarah McNamara closed XALANJ-2048:
----------------------------------


> Cleanup of javadoc to reduce the number of warnings during doc builds
> ---------------------------------------------------------------------
>
>          Key: XALANJ-2048
>          URL: http://issues.apache.org/jira/browse/XALANJ-2048
>      Project: XalanJ2
>         Type: Bug
>   Components: Xalan
>     Versions: Latest Development Code
>     Reporter: Sarah McNamara
>     Assignee: Sarah McNamara
>     Priority: Minor
>      Fix For: 2.7

>
> Although we can successfully build the api documentation, there are quite a number of warnings issued during the javadoc build.  Inspection of the code reveals that we have many @param tags that contain incorrectly spelled or non-existent parameters in the method signatures.  
> The javadoc really needs a complete overall at some point to correct/update the descriptions of methods, parameters, return values, exceptions, etc.   This bug report is not intended to address is larger issue.   For now, the cleanup to reduce the number of warnings is all that is intended.

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


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


[jira] Updated: (XALANJ-2048) Cleanup of javadoc to reduce the number of warnings during doc builds

Posted by "Brian Minchau (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2048?page=all ]

Brian Minchau updated XALANJ-2048:
----------------------------------

    Fix Version: 2.7
                     (was: CurrentCVS)

> Cleanup of javadoc to reduce the number of warnings during doc builds
> ---------------------------------------------------------------------
>
>          Key: XALANJ-2048
>          URL: http://issues.apache.org/jira/browse/XALANJ-2048
>      Project: XalanJ2
>         Type: Bug
>   Components: Xalan
>     Versions: CurrentCVS
>     Reporter: Sarah McNamara
>     Assignee: Sarah McNamara
>     Priority: Minor
>      Fix For: 2.7

>
> Although we can successfully build the api documentation, there are quite a number of warnings issued during the javadoc build.  Inspection of the code reveals that we have many @param tags that contain incorrectly spelled or non-existent parameters in the method signatures.  
> The javadoc really needs a complete overall at some point to correct/update the descriptions of methods, parameters, return values, exceptions, etc.   This bug report is not intended to address is larger issue.   For now, the cleanup to reduce the number of warnings is all that is intended.

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


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


[jira] Resolved: (XALANJ-2048) Cleanup of javadoc to reduce the number of warnings during doc builds

Posted by "Sarah McNamara (JIRA)" <xa...@xml.apache.org>.
     [ http://issues.apache.org/jira/browse/XALANJ-2048?page=history ]
     
Sarah McNamara resolved XALANJ-2048:
------------------------------------

    Resolution: Fixed

Fixed in latest cvs.  
Unfortunately some warnings remain due to javax.xml packages that are included in our javadocs.  These issues would need to be fixed in the xml-commons source.  

> Cleanup of javadoc to reduce the number of warnings during doc builds
> ---------------------------------------------------------------------
>
>          Key: XALANJ-2048
>          URL: http://issues.apache.org/jira/browse/XALANJ-2048
>      Project: XalanJ2
>         Type: Bug
>   Components: Xalan
>     Versions: CurrentCVS
>     Reporter: Sarah McNamara
>     Assignee: Sarah McNamara
>     Priority: Minor
>      Fix For: CurrentCVS

>
> Although we can successfully build the api documentation, there are quite a number of warnings issued during the javadoc build.  Inspection of the code reveals that we have many @param tags that contain incorrectly spelled or non-existent parameters in the method signatures.  
> The javadoc really needs a complete overall at some point to correct/update the descriptions of methods, parameters, return values, exceptions, etc.   This bug report is not intended to address is larger issue.   For now, the cleanup to reduce the number of warnings is all that is intended.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira


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