commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Honton, Charles" <Charles_Hon...@intuit.com>
Subject Re: [POOL] documenting the public API
Date Fri, 04 May 2012 16:03:50 GMT
Making the public api mostly interfaces (with a few immutable value
transfer classes) helps this delineation.


Chas

On 5/4/12 8:14 AM, "sebb" <sebbaz@gmail.com> wrote:

>I think it would be useful to try and specify upfront which public
>classes / methods etc are intended to form part of the public API, to
>distinguish them from items that are public merely to allow internal
>access between packages.
>
>If changes are later needed to public classes that are documented as
>not being part of the public API, we can potentially break binary
>compatibility if necessary.
>
>Maybe consider using a separate package name element such as "internal" ?
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>For additional commands, e-mail: dev-help@commons.apache.org
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message