[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [platform-dev] Comments on API to remove
|
- From: Jens Lideström <jens@xxxxxxxxxxxx>
- Date: Sun, 24 May 2020 11:25:24 +0200
- Autocrypt: addr=jens@xxxxxxxxxxxx; prefer-encrypt=mutual; keydata= xsBNBFM3R1gBCADKS+OHlSpEmXiVEvq+JdjOwaNT9M4udDAWvHOOL0UQBzdHc9aw3IEah7m6 pKxVNMkgafALaRKAUzpZawxtmFqzBVU8ytOiFPu7uBsgQeoVVQj4BX5qAcE4K6PeN4jzzEec Q1CFsci781hSS3lXoQg3a+5FVrtqvqUGqlwyuPwTJbGmh5Z41SmjKWNV8+H2gAOwqI5vZMwq xZ/hiWwgTh/ZC25dhXHgFNfvYo0HcBa2SIxMzjnuY0kI1lTI8hJ+SH5fIYlWAX5v2sCPlZPn 9xlxsoM5hrDy8WYjSikB9mEpl2a1sK3G9SYygTkxzSXhQfX5W7ffFyrevxAtTPGvSWbdABEB AAHNI0plbnMgTGlkZXN0csO2bSA8amVuc0BsaWRlc3Ryb20uc2U+wsB+BBMBAgAoBQJTN0dY AhsDBQkSzAMABgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRCHLK7pu7tB1hXVB/9QFmkY o8N+fqGHVPY74T0SgbtK/aspKE53lvyIjEJ4dB5kEXn5X4yjrAHCMWi6DP8qs6d7/4pW3Er5 lWh1ERnbGfBVe+jZQZ+UtwyMM6rjVw8VXC3n9l4j5+aqWI2bpst2bRKff1Hzi5/V+kEgySSQ osp+iuoIARIJj4ztydg8Y7JKpY2MMujEezrQ06MmPHD3Pgmw47aRuaMxA1eBsDW48nBtLzz1 NrR6Ze67DSVgXf7waTsVG13g6lM6ktNvlYPHg/9blr2HVknPtibxvmpUODaX8Yn9MkIayq7/ 4LDtFl0iXcPQViTbscOLEjCBCFE5ZbumIffRD2XL6K/wVCwGzsBNBFM3R1gBCAC0VvtL3Cgt Fg0zC5/89FXhC3a3UHe7lgFIaQX0SLJluC/hJitdUTP4ak6toim+N2AkVJk7KX74ZUEef1em i3UPv/yAUaAOoeNcsJYd9dUx7c54SA3sxk0btTsnXL7Ibb9ada7p8ur2rzEtqFdGqPsinHZU Qyr0PXxFXc7HbnAery9AzdzUdsAVURKFiJBvZiDzUChhQl3oCfh8giXVhYWVLrxzNYj24+CL CzUr5E75bJj96JArrDgPxCX3KdqHmZdMqOScgl09x0Homoia8AS9o54IqO9PIkFXWGaPOlQa to12ZXtFQ6K8dpaRsiQmxz+26Kl6mn398f8gY/o+LMnZABEBAAHCwGUEGAECAA8FAlM3R1gC GwwFCRLMAwAACgkQhyyu6bu7QdYsjAgAvDtqMbhH8TFfZzJDLM5JLv/H6gVATvggzOQOuiNq lcTe0AIGgM3upJlRFZbcpH1jojwnPqMue1RHvcDmiWDV0gho0zqYkTx41GdmaIYM4pC28Fa9 FR4Z2q1HF8T+Y9VyKNG2eOwyyNkT+Zc3bMkkz5psavcATFjDK2Z+2/rOSIJvQv5xIUGxCW9y bDMjq8O1efTeUVM+d5NKs1b2cgkkjLt3D5usFQeB3Yj0b/xZ4aqde+B0tD969AO0AJv1EI4N L3TdgYa3ooMupNGgo4WEKDjGh7OKKqrf2Qvan+7Uyf0SMnxEe5hTA7DMq7fmxkA6mlSo1VD8 r77Q+SIwfF6P9A==
- Delivered-to: platform-dev@xxxxxxxxxxx
- List-archive: <https://www.eclipse.org/mailman/private/platform-dev>
- List-help: <mailto:platform-dev-request@eclipse.org?subject=help>
- List-subscribe: <https://www.eclipse.org/mailman/listinfo/platform-dev>, <mailto:platform-dev-request@eclipse.org?subject=subscribe>
- List-unsubscribe: <https://www.eclipse.org/mailman/options/platform-dev>, <mailto:platform-dev-request@eclipse.org?subject=unsubscribe>
- User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.7.0
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 <jens@xxxxxxxxxxxx> 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@xxxxxxxxxxx
>> To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
>
>
