[
https://issues.apache.org/jira/browse/LUCENE-8115?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16308582#comment-16308582
]
Hoss Man commented on LUCENE-8115:
----------------------------------
sorry -- i think i answered my own question by re-reading the regex in the
patch a few more times and thinking it through...
IIUC this issue is not about defining *any* use of \@inheritDoc as
unneccessary, it's about identifying and preventing the specific situation of
\@inheritDoc usage that is fundementally unneccessary because there is no other
content in the javadoc.
Ie: {{/\*\* \{@inheritDoc\} \*/}} is an "unneccessary" use of the tag, because
we get the same effect by eliminating the javadoc completley. Meanwhile
something like {{/\*\* Just like our parent but better \{@inheritDoc\} \*/}}
would still be allowed.
do i have that correct?
> fail precommit on unnecessary {@inheritDoc} use
> -----------------------------------------------
>
> Key: LUCENE-8115
> URL: https://issues.apache.org/jira/browse/LUCENE-8115
> Project: Lucene - Core
> Issue Type: Task
> Reporter: Christine Poerschke
> Assignee: Christine Poerschke
> Priority: Minor
> Attachments: LUCENE-8115-step2.patch
>
>
> * Step 1: identify and remove existing unnecessary {{\{@inheritDoc\}}} use
> e.g. via IDE tooling or {{git grep -C 1 inheritDoc}}.
> * Step 2: change {{ant validate}} so that precommit fails if/when any new
> unnecessary {{\{@inheritDoc\}}} are introduced.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
