[ 
https://issues.apache.org/jira/browse/XALANJ-2553?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13250134#comment-13250134
 ] 

Steven J. Hathaway commented on XALANJ-2553:
--------------------------------------------

XALANJ-2553 JavaDoc Comments

Related Files:  Needs Confirmation -- Identify needed comment changes

transformer/SerializerSwitcher.java:   * @param transformer Non-null 
transformer instance
transformer/TreeWalker2Result.java:   * @param transformer Non-null transformer 
instance

                
> Inconsistent Javadoc comment and code for 
> switchSerializerIfHTML(TransformerImpl, String, String) in 
> org.apache.xalan.transformer.SerializerSwitcher
> ----------------------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: XALANJ-2553
>                 URL: https://issues.apache.org/jira/browse/XALANJ-2553
>             Project: XalanJ2
>          Issue Type: Bug
>      Security Level: No security risk; visible to anyone(Ordinary problems in 
> Xalan projects.  Anybody can view the issue.) 
>          Components: Xalan
>    Affects Versions: 2.7.1
>         Environment: Platform independent
>            Reporter: SHIN HWEI TAN
>              Labels: javadoc
>   Original Estimate: 0.05h
>  Remaining Estimate: 0.05h
>
> The Javadoc comment below states that the parameter transformer "Non-null 
> transformer instance":
>       /**
>       * ..
>       * @param transformer Non-null transformer instance
>       * @param ns Namespace URI of the element
>       * @param localName Local part of name of element
>       *...
>       */
>   public static void switchSerializerIfHTML(TransformerImpl transformer, 
> String ns, String localName)
> However, the method return normally without throwing any exception when 
> called with a null transformer. 
> Suggested Fixes:
> 1. Change "@param transformer Non-null transformer instance" to "@param 
> transformer transformer instance, null will be ignored"
> or
> 2. Remove "Non-null" from @param.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: 
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

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

Reply via email to