Re: [eclipse-dev] New and noteworthy for the APIs

[David M Williams <david_williams@xxxxxxxxxx>]

Well ... as an "old time user"
(that's a good thing, right? :) .... I think such a document would be very
useful. I'd hope its not pure auto-generated, though ... it would be more
helpful to have some *brief* overview or orientation to the changes.  To
illustrate, in the past we've often been pointed to the build notes for
such new/changed APIs ... but that lists 18 components in the base Eclipse
.... I don't think there's really 18 ... is there? ... and a raw list of
java doc and PR links is little better than grepping the code. 

Thanks for looking for continuous process
improvements. 

David

Pascal Rapicault <Pascal_Rapicault@xxxxxxxxxx>
Sent by: eclipse-dev-admin@xxxxxxxxxxx

03/07/2005 08:52 PM

Please respond to
eclipse-dev

To	eclipse-dev@xxxxxxxxxxx
cc
Subject	[eclipse-dev] New and noteworthy for the APIs

Hello, 

Regularly eclipse grows its APIs. This is fine and well. However we are
not doing a good job of advertising those new APIs to our old time users.
Instead of letting them grep the code base for @since 3.1, I suggest that
we deliver a document called "APIs, New and Noteworthy" containing
all the new APIs since the last release. 
For new classes, this document would hold a link to the class in the javadoc
and maybe the javadoc. 
For new methods and fields this document would contain the signature and
the appropriate javadoc. 

The creation of this document should be automatic since all the relevant
information are available in the source (it could be hooked to the tool
doing API enforcement). 
Before going any further, please provide feedback.

Thank you, 

PaScaL