[dna-issues] [JBoss JIRA] Commented: (DNA-445) Formally Delineate the Public API

[Randall Hauch (JIRA)]

    [ https://jira.jboss.org/jira/browse/DNA-445?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12499051#action_12499051 ] 

Randall Hauch commented on DNA-445:
-----------------------------------

Per TAG-29, we need to provide a set of public API JavaDocs that have only the publicly-accessible classes/interfaces.  This shouldn't be too difficult, as it basically entails a different JavaDoc configuration to limit the packages and visibility.  

Generally, our approach is that every public class in our public API packages should be part of the public API; any classes with other visibility (or classes in other packages) are not considered part of the API.  We really just need to put together the list of public API packages, and that can be done in the JavaDoc configuration (keeping it DRY).

Note that we may want to change the existing JavaDoc assembly into the public API artifact, and (if desired) _add_ another JavaDoc assembly that creates the "developer JavaDoc".


> Formally Delineate the Public API
> ---------------------------------
>
>                 Key: DNA-445
>                 URL: https://jira.jboss.org/jira/browse/DNA-445
>             Project: DNA
>          Issue Type: Feature Request
>          Components: API
>    Affects Versions: 0.4
>            Reporter: Brian Carothers
>             Fix For: 1.1
>
>
> DNA has a fairly large number of classes, not all of which are intended to be stable.  Although some examples and documentation "best practices" for utilizing the API are provided, there is no explicit contract in the API that indicates which portions of the API are expected to remain stable and supported over time.
> A comparable discussion was occurring on the jboss-development mailing list (https://lists.jboss.org/mailman/listinfo/jboss-development)  Vol. 36 Issue 8 et al.  It appears that Eclipse uses annotations to provide this information.  These annotations (http://www.opends.org/promoted-builds/2.0.0-RC1/javadoc/org/opends/server/types/PublicAPI.html and http://www.eclipse.org/pde/pde-api-tools/) were tossed around in the discussion.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira