Uploaded image for project: 'Jackrabbit Oak'
  1. Jackrabbit Oak
  2. OAK-7301

Javadoc: document hidden assumptions and invariants

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • segment-tar

    Description

      We should improve API documentation wrt. hidden assumption and invariants: where the result of calling a method of a class depends on some state of the system this should be clearly stated and explained in the Javadoc.

      Attachments

        Activity

          People

            Unassigned Unassigned
            mduerig Michael Dürig
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: