You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@xalan.apache.org by "SHIN HWEI TAN (Created) (JIRA)" <xa...@xml.apache.org> on 2012/04/06 22:49:21 UTC
[jira] [Created] (XALANJ-2553) Inconsistent Javadoc comment and
code for switchSerializerIfHTML(TransformerImpl, String, String) in
org.apache.xalan.transformer.SerializerSwitcher
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
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-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org
[jira] [Commented] (XALANJ-2553) Inconsistent Javadoc comment and
code for switchSerializerIfHTML(TransformerImpl, String, String) in
org.apache.xalan.transformer.SerializerSwitcher
Posted by "Steven J. Hathaway (Commented) (JIRA)" <xa...@xml.apache.org>.
[ 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-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org
[jira] [Commented] (XALANJ-2553) Inconsistent Javadoc comment and
code for switchSerializerIfHTML(TransformerImpl, String, String) in
org.apache.xalan.transformer.SerializerSwitcher
Posted by "SHIN HWEI TAN (Commented) (JIRA)" <xa...@xml.apache.org>.
[ https://issues.apache.org/jira/browse/XALANJ-2553?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13250380#comment-13250380 ]
SHIN HWEI TAN commented on XALANJ-2553:
---------------------------------------
The Javadoc comments reported above are referring to the @param transformer Non-null transformer instance reference tag in the transformer/SerializerSwitcher.java file.
The Javadoc comments in the TreeWalker2Result.java file are the same but the method behaves differently. In the SerializerSwitcher class, the method has a check for null transformer but simply return normally. In contrast, in the TreeWalker2Result class, the TreeWalker2Result(TransformerImpl ,SerializationHandler) constructor does not have any check for null transformer.
> 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-unsubscribe@xml.apache.org
For additional commands, e-mail: xalan-dev-help@xml.apache.org