uschindler commented on code in PR #13328:
URL: https://github.com/apache/lucene/pull/13328#discussion_r1584262673
##########
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:
Hi,
I know where this comes from:
https://github.com/apache/lucene/blob/9af3ef8952597ead37a5a9ce5373ed3bbd40238e/gradle/documentation/render-javadoc.gradle#L196-L218
Actually for the codecs package we require javadocs for all methods, but not
for the utils package.
The problem here is that it complains about synthetic methods. Let me play
around with that a bit later. For enums the missing doclets checker has some
code, i think thats exactly the same problem here. Maybe we can fix it in the
same way like for synthetic methods and constructors of enums.
--
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: issues-unsubscr...@lucene.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
