[
https://issues.apache.org/jira/browse/SOLR-17398?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
ASF GitHub Bot updated SOLR-17398:
----------------------------------
Labels: pull-request-available (was: )
> 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
> Time Spent: 10m
> 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]
