I prefer the public API being declared in the README, not the Javadoc. Javadoc is a pain to maintain, and I think its use should be limited to describing API semantics of the specific, narrowly-scoped class, method, field, or even package it is attached to. Further, it is intended to be viewed in a rendered form... not raw HTML embedded inside a Java comment. Linking from the README to the Accumulo.java file isn't doing users any favors.
Also, I'm pretty sure there's no reason to turn off checkstyle for the javadoc. That's just asking for trouble, potentially introducing rendering issues that should have been caught earlier. As for the class move, I think that's fine, although ultimately, I'd prefer the main entry point be in a separate API jar, so the API definition is just "everything accessible in accumulo-api.jar", but that will take more work to avoid dependency cycles between jars. [ Full content available at: https://github.com/apache/accumulo/pull/656 ] This message was relayed via gitbox.apache.org for [email protected]
