[MAGNOLIA-4777] Confusing Javadoc and method names for info.magnolia.jcr.decoration.ContentDecorator Created: 16/Jan/13  Updated: 19/May/22  Resolved: 19/May/22

Status: Closed
Project: Magnolia
Component/s: core
Affects Version/s: 4.5.7
Fix Version/s: 4.5.x

Type: Bug Priority: Neutral
Reporter: Magnolia International Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: next
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled
Date of First Response:

 Description   

The javadoc for evaluateNode() and evaluateProperty() contradicts itself.

    /**
     * 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);

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)



 Comments   
Comment by Tobias Mattsson [ 03/Dec/13 ]

You're right, the javadoc is incorrect. The methods naming is unfortunate, the names comes from being implemented as predicates in an earlier revision, where the method is named evaluate. I don't think changing the method names is worth the effort. Instead we should improve the javadoc to make it absolutely clear what these methods do.

Comment by Roman Kovařík [ 19/May/22 ]

Hello,

This ticket is now marked as closed due to one of the following reasons:

  • A long period of inactivity
  • Uses an old or Beta version of an application, module, or framework that we no longer support
  • The issue is no longer reproducible or has been fixed in later versions

If you are still facing a problem or consider this issue still relevant, please feel free to re-open the ticket and we will reach out to you.

Thank you,
The Magnolia Team

Generated at Mon Feb 12 03:58:56 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.