[
https://issues.apache.org/jira/browse/LUCENE-5389?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13867429#comment-13867429
]
Robert Muir commented on LUCENE-5389:
-------------------------------------
OK, i took a look. I had to make a fix for documentation-lint to pass,
basically it didnt like the multiline \{@code} element you had for the code
sample, because 'javadoc' would give an error that it couldnt find the closing
brace. Maybe the \{@override} was messing it up. In general i've never used
multiline \{@code} before... Anyway i just made it consistent with other code
samples by doing this:
{code}
<pre class="prettyprint">
public class ForwardingTokenizer extends Tokenizer {
private Tokenizer delegate;
...
{@literal @Override}
public void reset() {
super.reset();
delegate.setReader(this.input);
delegate.reset();
}
}
</pre>
{code}
The class="prettyprint" gives colored syntax highlighting in the javadocs, and
the override is escaped with literal. At least these are the way the others are
done.
I'm committing this. Do you want to make a patch to trunk-only to update the
5.x docs with respect to LUCENE-5388? Stuff like "(A future release of Apache
Lucene may remove the reader parameters from the Tokenizer constructors.)"
Thanks!
> Even more doc for construction of TokenStream components
> --------------------------------------------------------
>
> Key: LUCENE-5389
> URL: https://issues.apache.org/jira/browse/LUCENE-5389
> Project: Lucene - Core
> Issue Type: Improvement
> Reporter: Benson Margulies
>
> There are more useful things to tell would-be authors of tokenizers. Let's
> tell them.
--
This message was sent by Atlassian JIRA
(v6.1.5#6160)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
