[dna-issues] [JBoss JIRA] Updated: (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:all-tabpanel ]

Randall Hauch updated DNA-445:
------------------------------

    Fix Version/s: 1.0


I think this would be a good addition, though I suspect that it may not be immediately clear for some of our classes.  Targeting to 1.0.

> 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.0
>
>
> 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