Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Correct some of the jdk17-offending javadocs.

This commit is contained in:
Dawid Weiss 2021-04-05 20:34:52 +02:00
parent 2773172455
commit 2662a74cab
8 changed files with 34 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lucene/analysis/common/src/java/org/apache/lucene/analysis/pt/RSLPStemmerBase.java
View File

@ -87,8 +87,6 @@ import org.apache.lucene.analysis.CharArraySet;
* completely as an optimization.
* </ul>
*
* <p>
*
* @see <a href="http://www.inf.ufrgs.br/~viviane/rslp/index.htm">RSLP description</a>
* @lucene.internal
*/

2
lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/Lucene80Codec.java
View File

@ -41,8 +41,6 @@ import org.apache.lucene.codecs.perfield.PerFieldPostingsFormat;
/**
* Implements the Lucene 8.0 index format.
*
* <p>
*
* @see org.apache.lucene.backward_codecs.lucene80 package documentation for file format details.
* @lucene.experimental
*/

28
lucene/core/src/java/org/apache/lucene/search/similarities/TFIDFSimilarity.java
View File

@ -74,10 +74,10 @@ import org.apache.lucene.util.SmallFloat;
* <table class="padding2" style="border-spacing: 2px; border-collapse: separate; border: 0; margin-left:auto; margin-right:auto">
* <caption>cosine similarity formula</caption>
* <tr>
* <td valign="middle" style="text-align: right" rowspan="1">
* <td style="vertical-align: middle; text-align: right" rowspan="1">
* cosine-similarity(q,d) &nbsp; = &nbsp;
* </td>
* <td valign="middle" style="text-align: center">
* <td style="vertical-align: middle; text-align: center">
* <table>
* <caption>cosine similarity formula</caption>
* <tr><td style="text-align: center"><small>V(q)&nbsp;&middot;&nbsp;V(d)</small></td></tr>
@ -144,11 +144,11 @@ import org.apache.lucene.util.SmallFloat;
* <table class="padding2" style="border-spacing: 2px; border-collapse: separate; border: 0; margin-left:auto; margin-right:auto">
* <caption>formatting only</caption>
* <tr>
* <td valign="middle" style="text-align: right" rowspan="1">
* <td style="vertical-align: middle; text-align: right" rowspan="1">
* score(q,d) &nbsp; = &nbsp;
* <span style="color: #CCCC00">query-boost(q)</span> &middot; &nbsp;
* </td>
* <td valign="middle" style="text-align: center">
* <td style="vertical-align: middle; text-align: center">
* <table>
* <caption>Lucene conceptual scoring formula</caption>
* <tr><td style="text-align: center"><small><span style="color: #993399">V(q)&nbsp;&middot;&nbsp;V(d)</span></small></td></tr>
@ -156,7 +156,7 @@ import org.apache.lucene.util.SmallFloat;
* <tr><td style="text-align: center"><small><span style="color: #FF33CC">|V(q)|</span></small></td></tr>
* </table>
* </td>
* <td valign="middle" style="text-align: right" rowspan="1">
* <td style="vertical-align: middle; text-align: right" rowspan="1">
* &nbsp; &middot; &nbsp; <span style="color: #3399FF">doc-len-norm(d)</span>
* &nbsp; &middot; &nbsp; <span style="color: #3399FF">doc-boost(d)</span>
* </td>
@ -220,11 +220,11 @@ import org.apache.lucene.util.SmallFloat;
* <table class="padding2" style="border-spacing: 2px; border-collapse: separate; border: 0; margin-left:auto; margin-right:auto">
* <caption>Lucene conceptual scoring formula</caption>
* <tr>
* <td valign="middle" style="text-align: right" rowspan="1">
* <td style="vertical-align: middle; text-align: right" rowspan="1">
* score(q,d) &nbsp; = &nbsp;
* <span style="font-size: larger">&sum;</span>
* </td>
* <td valign="middle" style="text-align: right" rowspan="1">
* <td style="vertical-align: middle; text-align: right" rowspan="1">
* <span style="font-size: larger">(</span>
* <A HREF="#formula_tf"><span style="color: #993399">tf(t in d)</span></A> &nbsp;&middot;&nbsp;
* <A HREF="#formula_idf"><span style="color: #993399">idf(t)</span></A><sup>2</sup> &nbsp;&middot;&nbsp;
@ -233,7 +233,7 @@ import org.apache.lucene.util.SmallFloat;
* <span style="font-size: larger">)</span>
* </td>
* </tr>
* <tr valign="top">
* <tr style="vertical-align: top">
* <td></td>
* <td style="text-align: center"><small>t in q</small></td>
* <td></td>
@ -263,10 +263,10 @@ import org.apache.lucene.util.SmallFloat;
* <table class="padding2" style="border-spacing: 2px; border-collapse: separate; border: 0; width:auto; margin-left:auto; margin-right:auto">
* <caption>term frequency computation</caption>
* <tr>
* <td valign="middle" style="text-align: right" rowspan="1">
* <td style="vertical-align: middle; text-align: right" rowspan="1">
* {@link org.apache.lucene.search.similarities.ClassicSimilarity#tf(float) tf(t in d)} &nbsp; = &nbsp;
* </td>
* <td valign="top" style="text-align: center" rowspan="1">
* <td style="vertical-align: top; text-align: center" rowspan="1">
* frequency<sup><span style="font-size: larger">&frac12;</span></sup>
* </td>
* </tr>
@ -284,13 +284,13 @@ import org.apache.lucene.util.SmallFloat;
* <table class="padding2" style="border-spacing: 2px; border-collapse: separate; border: 0; width:auto; margin-left:auto; margin-right:auto">
* <caption>inverse document frequency computation</caption>
* <tr>
* <td valign="middle" style="text-align: right">
* <td style="vertical-align: middle; text-align: right">
* {@link org.apache.lucene.search.similarities.ClassicSimilarity#idf(long, long) idf(t)}&nbsp; = &nbsp;
* </td>
* <td valign="middle" style="text-align: center">
* <td style="vertical-align: middle; text-align: center">
* 1 + log <span style="font-size: larger">(</span>
* </td>
* <td valign="middle" style="text-align: center">
* <td style="vertical-align: middle; text-align: center">
* <table>
* <caption>inverse document frequency computation</caption>
* <tr><td style="text-align: center"><small>docCount+1</small></td></tr>
@ -298,7 +298,7 @@ import org.apache.lucene.util.SmallFloat;
* <tr><td style="text-align: center"><small>docFreq+1</small></td></tr>
* </table>
* </td>
* <td valign="middle" style="text-align: center">
* <td style="vertical-align: middle; text-align: center">
* <span style="font-size: larger">)</span>
* </td>
* </tr>

40
lucene/core/src/java/org/apache/lucene/store/DataOutput.java
View File

@ -100,89 +100,89 @@ public abstract class DataOutput {
*
* <table class="padding2" style="border-spacing: 0px; border-collapse: separate; border: 0">
* <caption>variable length encoding examples</caption>
* <tr valign="top">
* <tr style="vertical-align: top">
* <th style="text-align:left">Value</th>
* <th style="text-align:left">Byte 1</th>
* <th style="text-align:left">Byte 2</th>
* <th style="text-align:left">Byte 3</th>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>0</td>
* <td><code>00000000</code></td>
* <td></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>1</td>
* <td><code>00000001</code></td>
* <td></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>2</td>
* <td><code>00000010</code></td>
* <td></td>
* <td></td>
* </tr>
* <tr>
* <td valign="top">...</td>
* <td valign="bottom"></td>
* <td valign="bottom"></td>
* <td valign="bottom"></td>
* <td style="vertical-align: top">...</td>
* <td></td>
* <td></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>127</td>
* <td><code>01111111</code></td>
* <td></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>128</td>
* <td><code>10000000</code></td>
* <td><code>00000001</code></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>129</td>
* <td><code>10000001</code></td>
* <td><code>00000001</code></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>130</td>
* <td><code>10000010</code></td>
* <td><code>00000001</code></td>
* <td></td>
* </tr>
* <tr>
* <td valign="top">...</td>
* <td style="vertical-align: top">...</td>
* <td></td>
* <td></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>16,383</td>
* <td><code>11111111</code></td>
* <td><code>01111111</code></td>
* <td></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>16,384</td>
* <td><code>10000000</code></td>
* <td><code>10000000</code></td>
* <td><code>00000001</code></td>
* </tr>
* <tr valign="bottom">
* <tr style="vertical-align: bottom">
* <td>16,385</td>
* <td><code>10000001</code></td>
* <td><code>10000000</code></td>
* <td><code>00000001</code></td>
* </tr>
* <tr>
* <td valign="top">...</td>
* <td valign="bottom"></td>
* <td valign="bottom"></td>
* <td valign="bottom"></td>
* <td style="vertical-align: top">...</td>
* <td ></td>
* <td ></td>
* <td ></td>
* </tr>
* </table>
*

6
lucene/highlighter/src/java/org/apache/lucene/search/highlight/WeightedSpanTermExtractor.java
View File

@ -500,8 +500,6 @@ public class WeightedSpanTermExtractor {
* Creates a Map of <code>WeightedSpanTerms</code> from the given <code>Query</code> and <code>
* TokenStream</code>.
*
* <p>
*
* @param query that caused hit
* @param tokenStream of text to be highlighted
* @return Map containing WeightedSpanTerms
@ -516,8 +514,6 @@ public class WeightedSpanTermExtractor {
* Creates a Map of <code>WeightedSpanTerms</code> from the given <code>Query</code> and <code>
* TokenStream</code>.
*
* <p>
*
* @param query that caused hit
* @param tokenStream of text to be highlighted
* @param fieldName restricts Term's used based on field name
@ -544,8 +540,6 @@ public class WeightedSpanTermExtractor {
* TokenStream</code>. Uses a supplied <code>IndexReader</code> to properly weight terms (for
* gradient highlighting).
*
* <p>
*
* @param query that caused hit
* @param tokenStream of text to be highlighted
* @param fieldName restricts Term's used based on field name

2
lucene/join/src/java/org/apache/lucene/search/join/JoinUtil.java
View File

@ -123,8 +123,6 @@ public final class JoinUtil {
* boolean, String, Query, IndexSearcher, ScoreMode)} are applicable here too, though memory
* consumption might be higher.
*
* <p>
*
* @param fromField The from field to join from
* @param multipleValuesPerDocument Whether the from field has multiple terms per document when
* true fromField might be {@link DocValuesType#SORTED_NUMERIC}, otherwise fromField should be

2
lucene/spatial3d/src/java/org/apache/lucene/spatial3d/Geo3DPoint.java
View File

@ -192,8 +192,6 @@ public final class Geo3DPoint extends Field {
/**
* Create a query for matching a path.
*
* <p>
*
* @param field field name. must not be null.
* @param pathLatitudes latitude values for points of the path: must be within standard +/-90
* coordinate bounds.

2
lucene/suggest/src/java/org/apache/lucene/search/spell/JaroWinklerDistance.java
View File

@ -21,8 +21,6 @@ import java.util.Arrays;
/**
* Similarity measure for short strings such as person names.
*
* <p>
*
* @see <a
* href="http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance">http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance</a>
*/