[
https://issues.apache.org/jira/browse/SOLR-17398?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18127149#comment-18127149
]
ASF subversion and git services commented on SOLR-17398:
--------------------------------------------------------
Commit fb56d1f6cc0f2d40bd1def3d3c2243c3908fc290 in solr's branch
refs/heads/branch_10_1 from Serhiy Bzhezytskyy
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=fb56d1f6cc0 ]
SOLR-17398: Link V1 collection operations to their V2 equivalents (#5053)
(cherry picked from commit 1d7a1e9062734acd37489e85173044d8d974c88a)
(cherry picked from commit 4c88380c161c31e40f35f9c5ab4e943dbef865f8)
> Add Javadoc links from V1 APIs to V2 APIs
> -----------------------------------------
>
> Key: SOLR-17398
> URL: https://issues.apache.org/jira/browse/SOLR-17398
> Project: Solr
> Issue Type: Sub-task
> Components: v2 API
> Reporter: David Smiley
> Priority: Minor
> Labels: pull-request-available
> Fix For: 10.2
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> The Java code for V1 APIs should have a javadoc comment pointing to
> equivalent v2 APIs when it's not obvious (when V1 is not simply calling V2
> and/or they occupy different classes). If V2 doesn't exist yet, a TBD/TODO
> comment is helpful nonetheless.
> For example in CollectionsHandler above the enum entry for CLUSTERSTATUS_OP,
> add:
> {quote}Superceded by V2: \{@link ClusterAPI} and \{@link ListAliasesApi}
> and \{@link CollectionStatusAPI}.
> {quote}
> In that specific case, the ClusterStatus class itself could be marked
> deprecated, albeit that deprecation should perhaps be only for Solr 10 as
> some of such classes will not be removed until Solr 11. Nonetheless a javadoc
> comment saying will be removed in Solr 11 would be very helpful!
> Perhaps in many cases there is no need because V1 tends to call V2.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
