[infinispan-dev] JavaDocs and API documentation

2014-02-26 Thread Tristan Tarrant
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

Re: [infinispan-dev] JavaDocs and API documentation

2014-02-26 Thread Mircea Markus
On Feb 26, 2014, at 1:05 PM, Tristan Tarrant ttarr...@redhat.com wrote: 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.

Re: [infinispan-dev] JavaDocs and API documentation

2014-02-26 Thread Tristan Tarrant
On 26/02/2014 15:02, Mircea Markus wrote: On Feb 26, 2014, at 1:05 PM, Tristan Tarrant ttarr...@redhat.com wrote: 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

Re: [infinispan-dev] JavaDocs and API documentation

2014-02-26 Thread Dan Berindei
On Wed, Feb 26, 2014 at 4:24 PM, Tristan Tarrant ttarr...@redhat.comwrote: On 26/02/2014 15:02, Mircea Markus wrote: On Feb 26, 2014, at 1:05 PM, Tristan Tarrant ttarr...@redhat.com wrote: Dear all, our JavaDocs currently encompass all of our classes, interfaces, etc with no clear

Re: [infinispan-dev] JavaDocs and API documentation

2014-02-26 Thread Vladimir Blagojevic
I agree, sounds like a sensible thing to do. But this needs to be planned carefully and when exactly is the good time to do it, soon and have it ready for 7.0.0.Final? On 2/26/2014, 10:29 AM, Dan Berindei wrote: If we move all internal classes to .impl sub-packages, it will be quite easy