From 426a9c25c241e174f64f522f87de2fe169a452ca Mon Sep 17 00:00:00 2001 From: Tomoko Uchida Date: Tue, 10 Nov 2020 23:57:09 +0900 Subject: [PATCH] LUCENE-9499: migrate package.html files into package-info.java (#2072) --- gradle/documentation/render-javadoc.gradle | 24 ----------- .../lucene/analysis/classic/package-info.java | 29 +++++++++++++ .../lucene/analysis/classic/package.html | 37 ---------------- .../lucene/analysis/email/package-info.java | 34 +++++++++++++++ .../apache/lucene/analysis/email/package.html | 39 ----------------- .../lucene50/package-info.java | 19 +++++++++ .../backward_codecs/lucene50/package.html | 25 ----------- .../lucene60/package-info.java | 19 +++++++++ .../backward_codecs/lucene60/package.html | 25 ----------- .../lucene80/package-info.java | 19 +++++++++ .../backward_codecs/lucene80/package.html | 25 ----------- .../lucene84/package-info.java | 19 +++++++++ .../backward_codecs/lucene84/package.html | 25 ----------- .../lucene86/package-info.java | 19 +++++++++ .../backward_codecs/lucene86/package.html | 25 ----------- .../lucene87/package-info.java | 19 +++++++++ .../backward_codecs/lucene87/package.html | 42 ------------------- .../lucene/backward_codecs/package-info.java | 19 +++++++++ .../lucene/backward_codecs/package.html | 26 ------------ .../lucene/misc/document/package-info.java | 19 +++++++++ .../apache/lucene/misc/document/package.html | 22 ---------- .../lucene/misc/index/package-info.java | 19 +++++++++ .../org/apache/lucene/misc/index/package.html | 22 ---------- .../lucene/misc/search/package-info.java | 19 +++++++++ .../apache/lucene/misc/search/package.html | 22 ---------- .../misc/search/similarity/package-info.java | 19 +++++++++ .../misc/search/similarity/package.html | 22 ---------- .../lucene/misc/store/package-info.java | 19 +++++++++ .../org/apache/lucene/misc/store/package.html | 22 ---------- .../lucene/misc/util/fst/package-info.java | 19 +++++++++ .../apache/lucene/misc/util/fst/package.html | 22 ---------- .../apache/lucene/misc/util/package-info.java | 20 +++++++++ .../org/apache/lucene/misc/util/package.html | 23 ---------- .../lucene/sandbox/document/package-info.java | 25 +++++++++++ .../lucene/sandbox/document/package.html | 32 -------------- .../lucene/sandbox/search/package-info.java | 19 +++++++++ .../apache/lucene/sandbox/search/package.html | 28 ------------- 37 files changed, 374 insertions(+), 508 deletions(-) create mode 100644 lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package-info.java delete mode 100644 lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package.html create mode 100644 lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package-info.java delete mode 100644 lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package.html create mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package-info.java delete mode 100644 lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/document/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/document/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/index/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/index/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/search/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/search/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/store/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/store/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/util/fst/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/util/fst/package.html create mode 100644 lucene/misc/src/java/org/apache/lucene/misc/util/package-info.java delete mode 100644 lucene/misc/src/java/org/apache/lucene/misc/util/package.html create mode 100644 lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package-info.java delete mode 100644 lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package.html create mode 100644 lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package-info.java delete mode 100644 lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package.html diff --git a/gradle/documentation/render-javadoc.gradle b/gradle/documentation/render-javadoc.gradle index 054b6523470..bbd1b5e603a 100644 --- a/gradle/documentation/render-javadoc.gradle +++ b/gradle/documentation/render-javadoc.gradle @@ -101,7 +101,6 @@ configure(project(":lucene:analysis:common")) { project.tasks.withType(RenderJavadocTask) { // TODO: fix missing javadocs javadocMissingLevel = "class" - javadocMissingIgnore = [ "org.apache.lucene.analysis.classic", "org.apache.lucene.analysis.email" ] } } @@ -150,16 +149,6 @@ configure(project(":lucene:backward-codecs")) { project.tasks.withType(RenderJavadocTask) { // TODO: fix missing @param tags javadocMissingLevel = "method" - // TODO: fix missing javadocs - javadocMissingIgnore = [ - "org.apache.lucene.backward_codecs", - "org.apache.lucene.backward_codecs.lucene50", - "org.apache.lucene.backward_codecs.lucene60", - "org.apache.lucene.backward_codecs.lucene80", - "org.apache.lucene.backward_codecs.lucene84", - "org.apache.lucene.backward_codecs.lucene86", - "org.apache.lucene.backward_codecs.lucene87" - ] } } @@ -194,10 +183,6 @@ configure(project(":lucene:sandbox")) { project.tasks.withType(RenderJavadocTask) { // TODO: fix missing javadocs javadocMissingLevel = "class" - javadocMissingIgnore = [ - "org.apache.lucene.sandbox.search", - "org.apache.lucene.sandbox.document" - ] } } @@ -205,15 +190,6 @@ configure(project(":lucene:misc")) { project.tasks.withType(RenderJavadocTask) { // TODO: fix missing javadocs javadocMissingLevel = "class" - javadocMissingIgnore = [ - "org.apache.lucene.misc.search", - "org.apache.lucene.misc.search.similarity", - "org.apache.lucene.misc.util", - "org.apache.lucene.misc.util.fst", - "org.apache.lucene.misc.store", - "org.apache.lucene.misc.document", - "org.apache.lucene.misc.index" - ] } } diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package-info.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package-info.java new file mode 100644 index 00000000000..4b2c47167aa --- /dev/null +++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package-info.java @@ -0,0 +1,29 @@ +/* + * 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. + */ + +/** + * Fast, general-purpose grammar-based tokenizers. + * {@link org.apache.lucene.analysis.classic.ClassicTokenizer ClassicTokenizer}: + * this class was formerly (prior to Lucene 3.1) named + * StandardTokenizer. (Its tokenization rules are not + * based on the Unicode Text Segmentation algorithm.) + * {@link org.apache.lucene.analysis.classic.ClassicAnalyzer ClassicAnalyzer} includes + * {@link org.apache.lucene.analysis.classic.ClassicTokenizer ClassicTokenizer}, + * {@link org.apache.lucene.analysis.LowerCaseFilter LowerCaseFilter} + * and {@link org.apache.lucene.analysis.StopFilter StopFilter}. + */ +package org.apache.lucene.analysis.classic; \ No newline at end of file diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package.html b/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package.html deleted file mode 100644 index d978878201f..00000000000 --- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/classic/package.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - Fast, general-purpose grammar-based tokenizers. - - - diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package-info.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package-info.java new file mode 100644 index 00000000000..0e7ea11f86b --- /dev/null +++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package-info.java @@ -0,0 +1,34 @@ +/* + * 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. + */ + +/** + * Fast, general-purpose URLs and email addresses tokenizers. + * + * */ +package org.apache.lucene.analysis.email; \ No newline at end of file diff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package.html b/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package.html deleted file mode 100644 index 59970c80562..00000000000 --- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/email/package.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - Fast, general-purpose URLs and email addresses tokenizers. - - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package-info.java new file mode 100644 index 00000000000..de5befee8ce --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Lucene 5.0 file format. */ +package org.apache.lucene.backward_codecs.lucene50; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package.html deleted file mode 100644 index 352cef4bf9a..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene50/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -Lucene 5.0 file format. - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package-info.java new file mode 100644 index 00000000000..3fd06845002 --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Lucene 6.0 file format. */ +package org.apache.lucene.backward_codecs.lucene60; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package.html deleted file mode 100644 index 6b4e234826d..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene60/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -Lucene 6.0 file format. - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package-info.java new file mode 100644 index 00000000000..3d4d9bde2d6 --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Lucene 8.0 file format. */ +package org.apache.lucene.backward_codecs.lucene80; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package.html deleted file mode 100644 index 9d64473d6d5..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -Lucene 8.0 file format. - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package-info.java new file mode 100644 index 00000000000..d122fcc24b3 --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Lucene 8.4 file format. */ +package org.apache.lucene.backward_codecs.lucene84; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package.html deleted file mode 100644 index d0ba893dfad..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene84/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -Lucene 8.4 file format. - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package-info.java new file mode 100644 index 00000000000..2d78f09345e --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Lucene 8.6 file format. */ +package org.apache.lucene.backward_codecs.lucene86; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package.html deleted file mode 100644 index 10560c624c2..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene86/package.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - -Lucene 8.6 file format. - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package-info.java new file mode 100644 index 00000000000..66a837906bd --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Lucene 8.7 file format. */ +package org.apache.lucene.backward_codecs.lucene87; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package.html deleted file mode 100644 index 3474ef9e52f..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene87/package.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - -Lucene 8.7 file format. - - diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package-info.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package-info.java new file mode 100644 index 00000000000..c2fe1f69c65 --- /dev/null +++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Common APIs for use by backwards compatibility codecs. */ +package org.apache.lucene.backward_codecs; \ No newline at end of file diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package.html b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package.html deleted file mode 100644 index fe01fff7b0b..00000000000 --- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/package.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - -Common APIs for use by backwards compatibility codecs. - - diff --git a/lucene/misc/src/java/org/apache/lucene/misc/document/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/document/package-info.java new file mode 100644 index 00000000000..0e37415bd6c --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/document/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Misc extensions of the Document/Field API. */ +package org.apache.lucene.misc.document; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/document/package.html b/lucene/misc/src/java/org/apache/lucene/misc/document/package.html deleted file mode 100644 index 3e55596b4ab..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/document/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - -Misc extensions of the Document/Field API. - - diff --git a/lucene/misc/src/java/org/apache/lucene/misc/index/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/index/package-info.java new file mode 100644 index 00000000000..3db8b5016e9 --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/index/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Misc index tools and index support. */ +package org.apache.lucene.misc.index; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/index/package.html b/lucene/misc/src/java/org/apache/lucene/misc/index/package.html deleted file mode 100644 index 33ce964eaf2..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/index/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - -Misc index tools and index support. - - diff --git a/lucene/misc/src/java/org/apache/lucene/misc/search/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/search/package-info.java new file mode 100644 index 00000000000..912b4780c9a --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/search/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Misc search implementations. */ +package org.apache.lucene.misc.search; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/search/package.html b/lucene/misc/src/java/org/apache/lucene/misc/search/package.html deleted file mode 100644 index 8683a16675f..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/search/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - -Misc search implementations. - - \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package-info.java new file mode 100644 index 00000000000..7f722632cd5 --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Misc similarity implementations. */ +package org.apache.lucene.misc.search.similarity; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package.html b/lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package.html deleted file mode 100644 index 7f624d41d54..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/search/similarity/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - -Misc similarity implementations. - - \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/store/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/store/package-info.java new file mode 100644 index 00000000000..a006862e94d --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/store/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Misc Directory implementations. */ +package org.apache.lucene.misc.store; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/store/package.html b/lucene/misc/src/java/org/apache/lucene/misc/store/package.html deleted file mode 100644 index 0bf56af6ae8..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/store/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - -Misc Directory implementations. - - diff --git a/lucene/misc/src/java/org/apache/lucene/misc/util/fst/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/util/fst/package-info.java new file mode 100644 index 00000000000..b7e79a9ea5f --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/util/fst/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** Misc FST classes. */ +package org.apache.lucene.misc.util.fst; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/util/fst/package.html b/lucene/misc/src/java/org/apache/lucene/misc/util/fst/package.html deleted file mode 100644 index 257801f805d..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/util/fst/package.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - -Misc FST classes. - - diff --git a/lucene/misc/src/java/org/apache/lucene/misc/util/package-info.java b/lucene/misc/src/java/org/apache/lucene/misc/util/package-info.java new file mode 100644 index 00000000000..691e8d9ac53 --- /dev/null +++ b/lucene/misc/src/java/org/apache/lucene/misc/util/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ + +/** Memory Tracker interface which allows defining custom collector + level memory trackers */ +package org.apache.lucene.misc.util; \ No newline at end of file diff --git a/lucene/misc/src/java/org/apache/lucene/misc/util/package.html b/lucene/misc/src/java/org/apache/lucene/misc/util/package.html deleted file mode 100644 index 24aa5071ae6..00000000000 --- a/lucene/misc/src/java/org/apache/lucene/misc/util/package.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - -Memory Tracker interface which allows defining custom collector -level memory trackers - - diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package-info.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package-info.java new file mode 100644 index 00000000000..c3e3a70d9b0 --- /dev/null +++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package-info.java @@ -0,0 +1,25 @@ +/* + * 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. + */ + +/** + * This package contains several point types: + * + */ +package org.apache.lucene.sandbox.document; \ No newline at end of file diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package.html b/lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package.html deleted file mode 100644 index 201bc6b65ea..00000000000 --- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/document/package.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - -This package contains several point types: - - - diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package-info.java b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package-info.java new file mode 100644 index 00000000000..c21c7422db7 --- /dev/null +++ b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package-info.java @@ -0,0 +1,19 @@ +/* + * 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. + */ + +/** This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial queries. */ +package org.apache.lucene.sandbox.search; \ No newline at end of file diff --git a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package.html b/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package.html deleted file mode 100644 index e4a0c8e2831..00000000000 --- a/lucene/sandbox/src/java/org/apache/lucene/sandbox/search/package.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - - - -This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial queries. - -