Document: Javadocs for the expression API

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Unknown
    • 4.9.0
    • Affects Version/s: None
    • Component/s: None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Any javadocs on the Expression interfaces (and the Expressions utility class) that are merged in to the expressions branch are considered tentative until this ticket is resolved, and methods might lack docs entirely. This does not apply to work outside of the Expression interfaces/Expressions class.

      It is not obvious how the docs should be written. For example, "returns logical true if this  Expression is evaluated to false" seems awkward and confusing, possibly because it mixes concepts from a variety of levels: abstract values, the specific interface, the idea of evaluation, the semantics versus the implementation, and so on. We would need to have a careful look at how JDK or other similar library javadoc might have solved some of these problems.

       

              Assignee:
              Maxim Katcharov
              Reporter:
              Maxim Katcharov
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: