Red Hat Bugzilla – Bug 1014655
JavaDoc should clearly indicated public API/SPI
Last modified: 2014-04-03 23:56:34 EDT
Currently the Javadocs include all classes/interfaces without distinction. We should clearly mark those that are part of the public API/SPI.
Blocks Docs API Documentation update bug.
Added myself as docs contact for this bug.
Tracking this issue in this bug.
Tristan, according to Martin, the non-public stuff is still in the API docs payload. Adding Martin and Tristan to this bug to track this issue.
As part of the API Docs review, Martin please confirm the non-public APIs are not in the docs anymore.
Misha, this will not be fixed for JDG 6.2 Beta. It needs more effort on productization side.
I've integrated the PR https://github.com/infinispan/jdg/pull/31 but I realise now this fixes the issues only partially. Let's not close this yet.
This bug includes the docs part of this requirement so please don't close it off till we can get the javadocs in the docs wrapper and staged on the docs server.
When your team is done testing CR1, would you mind posting here about whether this requirement was met in the included javadocs? If do, we can just close off this bug.
I've checked the docs included in the library distribution. The docs are mostly correct but I have a few comments:
The following classes/interfaces are IMO redundant and should not be public:
I'm missing in the docs interfaces from package org.infinispan.persistence.spi, such as:
CacheLoader, CacheWriter, ExternalStore, AdvancedCacheLoader, etc.
Based on Martin's comments, this should probably be back on ASSIGNED.
Updated this and docs API Documentation bug to ASSIGNED to indicate further action required.