More important than the Javadoc is to follow every step in https://wiki.eclipse.org/Eclipse/API_Central/API_Removal_Process.
Dani From: "Jens Lideström" <j...@lidestrom.se> To: "Eclipse platform general developers list." <platform-dev@eclipse.org> Date: 23.05.2020 17:33 Subject: [EXTERNAL] [platform-dev] Comments on API to remove Sent by: platform-dev-boun...@eclipse.org 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
