Document deprecations

[elharo]

New feature, improvement proposal

A number of methods in this project are deprecated without any docs explaining why they're deprecated or how to replace them. e.g. getWorkItem and setWorkItem in ScmProviderRepository

Document or undeprecate these.

[anukalp2804]

Hi @elharo,

I’ve set up the project locally and verified that the build succeeds.
I reviewed deprecated methods such as getWorkItem and setWorkItem in
ScmProviderRepository and confirmed they lack Javadoc explaining the reason
for deprecation or suggested replacements.

Before proceeding, could you please confirm whether the preferred approach
is to document these deprecations, or to consider undeprecating any of them?

Thanks.

[elharo]

It's case by case. It depends completely on whether each one should be deprecated and whether it's still needed or not.

[anukalp2804]

Thanks for the clarification.

I’ll go through the deprecated methods one by one and evaluate whether each
should remain deprecated or be undeprecated, and document them accordingly.
I’ll open a PR once I have concrete changes.

Thanks.

[elharo]

This can be multiple PRs, one for each group of related deprecations.