Uploaded image for project: 'Magnolia'
  1. Magnolia
  2. MAGNOLIA-4777

Confusing Javadoc and method names for info.magnolia.jcr.decoration.ContentDecorator

    XMLWordPrintable

Details

    • Bug
    • Resolution: Won't Do
    • Neutral
    • 4.5.x
    • 4.5.7
    • core

    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)

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              Unassigned Unassigned
              gjoseph Magnolia International
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Bug DoR
                  Task DoD