shubhamvishu commented on code in PR #13328:
URL: https://github.com/apache/lucene/pull/13328#discussion_r1584249124
##########
lucene/core/src/java/org/apache/lucene/codecs/TermStats.java:
##########
@@ -16,24 +16,10 @@
*/
package org.apache.lucene.codecs;
-import org.apache.lucene.index.TermsEnum; // javadocs
-
/**
* Holder for per-term statistics.
*
- * @see TermsEnum#docFreq
- * @see TermsEnum#totalTermFreq
+ * @param docFreq How many documents have at least one occurrence of this term.
+ * @param totalTermFreq Total number of times this term occurs across all
documents in the field.
*/
-public class TermStats {
- /** How many documents have at least one occurrence of this term. */
- public final int docFreq;
-
- /** Total number of times this term occurs across all documents in the
field. */
- public final long totalTermFreq;
-
- /** Sole constructor. */
- public TermStats(int docFreq, long totalTermFreq) {
- this.docFreq = docFreq;
- this.totalTermFreq = totalTermFreq;
- }
-}
+public record TermStats(int docFreq, long totalTermFreq) {}
Review Comment:
Here is what the failure message looks like :
```
> Task :lucene:core:renderSiteJavadoc
/home/runner/work/lucene/lucene/lucene/core/src/java/org/apache/lucene/codecs/TermStats.java:25:
error: TermStats.<init> (constructor): javadocs are missing
public record TermStats(int docFreq, long totalTermFreq) {}
^
error: TermStats.docFreq (method): javadocs are missing
error: TermStats.totalTermFreq (method): javadocs are missing
/home/runner/work/lucene/lucene/lucene/core/src/java/org/apache/lucene/index/ReaderSlice.java:27:
error: ReaderSlice.<init> (constructor): javadocs are missing
public record ReaderSlice(int start, int length, int readerIndex) {
^
error: ReaderSlice.start (method): javadocs are missing
error: ReaderSlice.length (method): javadocs are missing
error: ReaderSlice.readerIndex (method): javadocs are missing
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
