Hi Jens, I think it is a good idea so that we document this for the users and the committers directly in the source code but this is not mandatory.
Best regards, Lars On Sun, May 24, 2020 at 11:25 AM Jens Lideström <j...@lidestrom.se> wrote: > > > Is it a good idea to include the earliest deletion date in the comment? > > Ex: > "This class will be removed in some future release after 2020-05-31." > > /Jens > > On 2020-05-23 19:02, Lars Vogel wrote: > > Hi Jens, > > > > I think that is a good comment. Thanks! > > > > Best regards, Lars > > > > On Sat, May 23, 2020 at 5:33 PM Jens Lideström <j...@lidestrom.se> wrote: > >> I'm in the process of marking some old databinding API for removal. I'm > >> not really sure how to write the Javadoc comment on the removed API. > >> > >> Is the following a good comment? > >> > >> /** > >> * XXX > >> * @deprecated This class will be removed in a future release. See > >> * https://bugs.eclipse.org/bugs/show_bug.cgi?id=546820 for > >> more > >> * information. Use XXX instead. > >> */ > >> > >> The wiki [1] says the following on this subject: > >> > >> """ > >> 5. Annotate all APIs that are to be removed with @noreference, @noextend > >> and @noimplement where applicable, update deprecation comment and add an > >> entry in the porting guide. Do the same for API that depends on it. The > >> deprecation comment and porting guide entry must explain how to adapt the > >> client code and also include a link to the bug report to allow feedback > >> from API adopters. > >> """ > >> > >> If my example above is a suitable comment I will update the wiki to > >> include it. > >> > >> [1]: https://wiki.eclipse.org/Eclipse/API_Central/API_Removal_Process > >> > >> /Jens > >> > >> > >> _______________________________________________ > >> platform-dev mailing list > >> platform-dev@eclipse.org > >> To unsubscribe from this list, visit > >> https://www.eclipse.org/mailman/listinfo/platform-dev > > > > > > _______________________________________________ > platform-dev mailing list > platform-dev@eclipse.org > To unsubscribe from this list, visit > https://www.eclipse.org/mailman/listinfo/platform-dev -- Eclipse Platform project co-lead CEO vogella GmbH Haindaalwisch 17a, 22395 Hamburg Amtsgericht Hamburg: HRB 127058 Geschäftsführer: Lars Vogel, Jennifer Nerlich de Vogel USt-IdNr.: DE284122352 Fax (040) 5247 6322, Email: lars.vo...@vogella.com, Web: http://www.vogella.com _______________________________________________ platform-dev mailing list platform-dev@eclipse.org To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
