You are viewing a plain text version of this content. The canonical link for it is here.

Posted to oak-issues@jackrabbit.apache.org by "Michael Dürig (JIRA)" <ji...@apache.org> on 2018/03/01 14:44:00 UTC

[jira] [Created] (OAK-7301) Javadoc: document hidden assumptions and invariants

Michael Dürig created OAK-7301:
----------------------------------

             Summary: Javadoc: document hidden assumptions and invariants 
                 Key: OAK-7301
                 URL: https://issues.apache.org/jira/browse/OAK-7301
             Project: Jackrabbit Oak
          Issue Type: Improvement
          Components: segment-tar
            Reporter: Michael Dürig


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.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)