Confusing Javadoc and method names for
info.magnolia.jcr.decoration.ContentDecorator
------------------------------------------------------------------------------------
Key: MAGNOLIA-4777
URL: http://jira.magnolia-cms.com/browse/MAGNOLIA-4777
Project: Magnolia
Issue Type: Bug
Security Level: Public
Components: core
Affects Versions: 4.5.7
Reporter: Grégory Joseph
Fix For: 4.5.8
The javadoc for {{evaluateNode()}} and {{evaluateProperty()}} contradicts
itself.
{noformat}
/**
* Evaluates if a node should be hidden by wrappers.
*<..>
* @return true if the node should be visible or false to hide it
*/
boolean evaluateNode(Node node);
{noformat}
>From code I've read, I *think* the {{@return}} doc is the correct one; the
>method doc should thus say "Evaluates if a node should be *shown* by wrappers."
As a side note, the method name might be clearer if it was "exposeNode" or
something similar - there is no evaluation of the node itself being done,
there's only, like the doc says, the fact that we do show this node/property or
not. (which in itself seems debatable - it sounds like it's something the
wrapper should do itself)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details, see: http://www.magnolia-cms.com/community/mailing-lists.html
Alternatively, use our forums: http://forum.magnolia-cms.com/
To unsubscribe, E-mail to: <[email protected]>
----------------------------------------------------------------
