You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@xalan.apache.org by "Steven J. Hathaway (Commented) (JIRA)" <xa...@xml.apache.org> on 2012/04/09 22:17:20 UTC

[jira] [Commented] (XALANJ-2556) Inconsistent Javadoc comment and code for execute(TransformerImpl) in org.apache.xalan.templates.ElemFallback

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

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

XALANJ-2556 JavaDoc Comments

Related Files:  Needs Confirmation -- Identify needed comment changes

templates/ElemApplyImport.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemApplyTemplates.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemApplyTemplates.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemAttribute.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemAttribute.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemAttributeSet.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemCallTemplate.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemChoose.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemComment.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemCopy.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemCopyOf.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemElement.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemElement.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemExtensionCall.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemExtensionCall.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemExtensionCall.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemFallback.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemFallback.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemForEach.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemForEach.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemIf.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemLiteralResult.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemMessage.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemNumber.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemNumber.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemNumber.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemNumber.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemNumber.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemNumber.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemParam.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemPI.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemTemplateElement.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemTemplateElement.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemTemplateElement.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemTemplateElement.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemTemplate.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemTextLiteral.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemUnknown.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemUnknown.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemUse.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemUse.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemUse.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemValueOf.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemVariable.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemVariable.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemVariablePsuedo.java:   * @param transformer non-null reference to the the current transform-time state.
templates/ElemWithParam.java:   * @param transformer non-null reference to the the current transform-time state.

                
> Inconsistent Javadoc comment and code for execute(TransformerImpl) in org.apache.xalan.templates.ElemFallback
> -------------------------------------------------------------------------------------------------------------
>
>                 Key: XALANJ-2556
>                 URL: https://issues.apache.org/jira/browse/XALANJ-2556
>             Project: XalanJ2
>          Issue Type: Bug
>      Security Level: No security risk; visible to anyone(Ordinary problems in Xalan projects.  Anybody can view the issue.) 
>    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 transformer is a "non-null reference to the the current transform-time state.":
>  /**
>   ...
>   * @param transformer non-null reference to the the current transform-time state.
>   ...
>   */
> public void execute(TransformerImpl transformer) throws TransformerException
> However, the method does not check the parameter for "null". It executes normally without throwing any exception when called with a null transformer. 
> Suggested Fixes:
> 1. Add parameter check for "null"
> 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