Bug 1014655 - JavaDoc should clearly indicated public API/SPI
Summary: JavaDoc should clearly indicated public API/SPI
Alias: None
Product: JBoss Data Grid 6
Classification: JBoss
Component: Documentation, Build
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
Target Milestone: CR2
: 6.2.1
Assignee: Misha H. Ali
QA Contact: Martin Gencur
Depends On:
Blocks: 951339 1067724 1074359
TreeView+ depends on / blocked
Reported: 2013-10-02 13:39 UTC by Tristan Tarrant
Modified: 2014-04-04 03:56 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
: 1067724 (view as bug list)
Last Closed: 2014-04-04 03:56:34 UTC
Type: Bug

Attachments (Terms of Use)

System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker ISPN-4074 0 Major Resolved Only include public API in JavaDoc 2016-06-22 02:43:31 UTC

Description Tristan Tarrant 2013-10-02 13:39:53 UTC
Currently the Javadocs include all classes/interfaces without distinction. We should clearly mark those that are part of the public API/SPI.

Comment 2 Misha H. Ali 2013-10-03 00:00:02 UTC
Blocks Docs API Documentation update bug.

Added myself as docs contact for this bug.

Comment 3 Misha H. Ali 2014-01-13 00:13:12 UTC
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.

Comment 4 Misha H. Ali 2014-01-14 01:41:45 UTC
As part of the API Docs review, Martin please confirm the non-public APIs are not in the docs anymore.

Comment 5 Martin Gencur 2014-01-14 09:42:03 UTC
Misha, this will not be fixed for JDG 6.2 Beta. It needs more effort on productization side.

Comment 8 Adrian Nistor 2014-03-06 16:46:47 UTC
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.

Comment 9 Misha H. Ali 2014-03-07 03:17:15 UTC
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.

Comment 10 Misha H. Ali 2014-03-12 04:05:04 UTC
Hi Martin,

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.

Comment 11 Martin Gencur 2014-03-20 08:37:53 UTC
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.

Comment 12 Misha H. Ali 2014-03-23 23:43:35 UTC
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.

Note You need to log in before you can comment on or make changes to this bug.