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/08 10:14:13 UTC
[jira] [Created] (XALANJ-2554) Inconsistent Javadoc comment and
code for setOutput(OutputProperties) in
org.apache.xalan.templates.Stylesheet
Inconsistent Javadoc comment and code for setOutput(OutputProperties) in org.apache.xalan.templates.Stylesheet
--------------------------------------------------------------------------------------------------------------
Key: XALANJ-2554
URL: https://issues.apache.org/jira/browse/XALANJ-2554
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, 2.7.1
Environment: Platform Independent
Reporter: SHIN HWEI TAN
The Javadoc comment below states that the parameter v is a "non-null reference to the OutputProperties object to be added to the collection":
/**
...
* @param v non-null reference to the OutputProperties object to be
* added to the collection.
*/
public void setOutput(OutputProperties v)
However, the method return normally without throwing any exception when called with a null v.
Suggested Fixes:
1. Change "@param v non-null reference to the OutputProperties object to be added to the collection." to "@param v reference to the OutputProperties object to be added to the collection,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-2554) Inconsistent Javadoc comment and
code for setOutput(OutputProperties) in
org.apache.xalan.templates.Stylesheet
Posted by "SHIN HWEI TAN (Commented) (JIRA)" <xa...@xml.apache.org>.
[ https://issues.apache.org/jira/browse/XALANJ-2554?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13253037#comment-13253037 ]
SHIN HWEI TAN commented on XALANJ-2554:
---------------------------------------
The Javadoc comments reported above are referring to the "@param v non-null reference to the OutputProperties object to be" tag in the templates/Stylesheet.java file.
Since a null element may be added to the m_output vector, the Javadoc comment "@return non-null reference to an OutputProperties object." for the corresponding getter (ie. getOutput(int i)) in templates/Stylesheet.java also need to be changed.
> Inconsistent Javadoc comment and code for setOutput(OutputProperties) in org.apache.xalan.templates.Stylesheet
> --------------------------------------------------------------------------------------------------------------
>
> Key: XALANJ-2554
> URL: https://issues.apache.org/jira/browse/XALANJ-2554
> 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, 2.7
> 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 v is a "non-null reference to the OutputProperties object to be added to the collection":
> /**
> ...
> * @param v non-null reference to the OutputProperties object to be
> * added to the collection.
> */
> public void setOutput(OutputProperties v)
> However, the method return normally without throwing any exception when called with a null v.
> Suggested Fixes:
> 1. Change "@param v non-null reference to the OutputProperties object to be added to the collection." to "@param v reference to the OutputProperties object to be added to the collection,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-2554) Inconsistent Javadoc comment and
code for setOutput(OutputProperties) in
org.apache.xalan.templates.Stylesheet
Posted by "Steven J. Hathaway (Commented) (JIRA)" <xa...@xml.apache.org>.
[ https://issues.apache.org/jira/browse/XALANJ-2554?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13250135#comment-13250135 ]
Steven J. Hathaway commented on XALANJ-2554:
--------------------------------------------
XALANJ-2554 JavaDoc Comments
Related Files: Needs Confirmation -- Identify needed comment changes
templates/OutputProperties.java: * @param method non-null reference to method name.
templates/OutputProperties.java: * @param root non-null reference to the stylesheet root object.
templates/OutputProperties.java: * @return non-null reference to Properties object.
templates/OutputProperties.java: * @param src non-null reference to the source properties.
templates/OutputProperties.java: * @param src non-null reference to the source properties.
templates/OutputProperties.java: * @param opsrc non-null reference to an OutputProperties.
templates/OutputProperties.java: * @param key non-null reference to key name.
templates/OutputProperties.java: * @param method non-null reference to method name.
templates/Stylesheet.java: * @param v non-null reference to the OutputProperties object to be
templates/Stylesheet.java: * @return non-null reference to an OutputProperties object.
> Inconsistent Javadoc comment and code for setOutput(OutputProperties) in org.apache.xalan.templates.Stylesheet
> --------------------------------------------------------------------------------------------------------------
>
> Key: XALANJ-2554
> URL: https://issues.apache.org/jira/browse/XALANJ-2554
> 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, 2.7
> 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 v is a "non-null reference to the OutputProperties object to be added to the collection":
> /**
> ...
> * @param v non-null reference to the OutputProperties object to be
> * added to the collection.
> */
> public void setOutput(OutputProperties v)
> However, the method return normally without throwing any exception when called with a null v.
> Suggested Fixes:
> 1. Change "@param v non-null reference to the OutputProperties object to be added to the collection." to "@param v reference to the OutputProperties object to be added to the collection,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