[infinispan-dev] JavaDocs and API documentation

Tristan Tarrant ttarrant at redhat.com
Wed Feb 26 08:05:54 EST 2014


Dear all,

our JavaDocs currently encompass all of our classes, interfaces, etc 
with no clear distinction between public and private API/SPI. I would 
like to clearly mark which of our classes/interfaces are public API. 
Should we:

- add some decoration / visual cue to such elements to distinguish them 
from the internal stuff
- generate two JavaDoc bundles: one which only contains the public 
API/SPIs and one with everything

Tristan



More information about the infinispan-dev mailing list