gsmiller commented on a change in pull request #543: URL: https://github.com/apache/lucene/pull/543#discussion_r779762733
########## File path: lucene/facet/src/java/org/apache/lucene/facet/MultiDoubleValues.java ########## @@ -0,0 +1,50 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.facet; + +import java.io.IOException; +import org.apache.lucene.search.DoubleValues; + +/** + * Per-segment, per-document double values, which can be calculated at search-time. Documents may + * produce multiple values. See also {@link DoubleValues} for a single-valued version. + * + * <p>Currently meant only for use within the faceting module. Could be further generalized and made + * available for more use-cases outside faceting if there is a desire to do so. + * + * @lucene.experimental + */ +public abstract class MultiDoubleValues { + + /** Instantiates a new MultiDoubleValues */ Review comment: The javadoc rendering build step is unhappy if I don't have these. We've loosened these requirements in other modules but the facets module retains stricter requirements (see `render-javadoc.gradle` config). So I think the only options are to add these ctors as a place to hook javadoc, or make the requirements less strict. I went with adding the doc since it seemed like overkill to make the requirements less strict just for this. Here's the error I see without these: ``` > Task :lucene:facet:renderSiteJavadoc /workplace/gmiller/upstream/benchmarks/candidate/lucene/facet/src/java/org/apache/lucene/facet/MultiLongValues.java:31: error - MultiLongValues.<init> (constructor): javadocs are missing /workplace/gmiller/upstream/benchmarks/candidate/lucene/facet/src/java/org/apache/lucene/facet/MultiDoubleValuesSource.java:53: error - MultiDoubleValuesSource.<init> (constructor): javadocs are missing /workplace/gmiller/upstream/benchmarks/candidate/lucene/facet/src/java/org/apache/lucene/facet/MultiLongValuesSource.java:56: error - MultiLongValuesSource.<init> (constructor): javadocs are missing /workplace/gmiller/upstream/benchmarks/candidate/lucene/facet/src/java/org/apache/lucene/facet/MultiDoubleValues.java:31: error - MultiDoubleValues.<init> (constructor): 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: 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
