This is an automated email from the ASF dual-hosted git repository. reschke pushed a commit to branch 1.22 in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
The following commit(s) were added to refs/heads/1.22 by this push: new 3cbbad5d47 OAK-8892 Add javadoc to package-info files 3cbbad5d47 is described below commit 3cbbad5d475f481c90dc0a4c755aa16de20442dc Author: Thomas Mueller <thom...@apache.org> AuthorDate: Wed Feb 19 14:35:09 2020 +0000 OAK-8892 Add javadoc to package-info files git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/oak/trunk@1874197 13f79535-47bb-0310-9956-ffa450edef68 --- .../oak/plugins/index/lucene/directory}/package-info.java | 9 ++++++--- .../oak/plugins/index/lucene/hybrid}/package-info.java | 9 ++++++--- .../oak/plugins/index/lucene/property}/package-info.java | 12 +++++++++--- .../oak/plugins/index/lucene/reader}/package-info.java | 9 ++++++--- .../oak/plugins/index/lucene/util/fv}/package-info.java | 10 +++++++--- .../oak/plugins/index/lucene/util}/package-info.java | 9 ++++++--- .../oak/plugins/index/lucene/writer}/package-info.java | 9 ++++++--- .../org/apache/jackrabbit/oak/query/facet/package-info.java | 4 ++++ .../jackrabbit/oak/spi/query/fulltext/package-info.java | 6 +++++- .../org/apache/jackrabbit/oak/spi/query/package-info.java | 4 ++++ .../jackrabbit/oak/plugins/index/search}/package-info.java | 9 ++++++--- .../oak/plugins/index/search/spi/binary}/package-info.java | 9 ++++++--- .../oak/plugins/index/search/spi/editor}/package-info.java | 10 +++++++--- .../oak/plugins/index/search/spi/query}/package-info.java | 9 ++++++--- .../oak/plugins/index/search/update}/package-info.java | 9 ++++++--- .../oak/plugins/index/search/util}/package-info.java | 9 ++++++--- 16 files changed, 96 insertions(+), 40 deletions(-) diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/package-info.java similarity index 81% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/package-info.java index a6d15dcba6..ee55a51b32 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains lucene directory related implementations. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.directory; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/hybrid/package-info.java similarity index 78% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/hybrid/package-info.java index a6d15dcba6..b769eed4fa 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/hybrid/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes related to lucene hybrid indices that forms the basis of NRT indexing. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.hybrid; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/package-info.java similarity index 64% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/package-info.java index a6d15dcba6..2a90d0d0b2 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/package-info.java @@ -14,7 +14,13 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes related to lucene hybrid index v2 where the index content + * is stored using both property index (for recent enrties) and lucene indexes (for older entries). Related + * document can be found + * <a href="http://jackrabbit.apache.org/archive/wiki/JCR/attachments/115513516/115513517.pdf">here</a>. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.property; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/reader/package-info.java similarity index 81% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/reader/package-info.java index a6d15dcba6..e5265d89c1 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/reader/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains lucene index reader related classes. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.reader; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/fv/package-info.java similarity index 68% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/fv/package-info.java index a6d15dcba6..c0631554b3 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/fv/package-info.java @@ -14,7 +14,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes for supporting <a href="http://jackrabbit.apache.org/oak/docs/query/lucene.html#similar-fv"> + * similarity search</a> which is based on <a href="https://en.wikipedia.org/wiki/Feature_(machine_learning)">feature</a> vectors. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.util.fv; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/package-info.java similarity index 81% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/package-info.java index a6d15dcba6..8e8023f98b 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains various indexing and search related helpers. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.util; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/package-info.java similarity index 81% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/package-info.java index a6d15dcba6..201fa05f2d 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes related lucene index writing. + */ +package org.apache.jackrabbit.oak.plugins.index.lucene.writer; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java index a6d15dcba6..c4041a65b9 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java @@ -14,6 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * This package contains facet related classes. + */ @Version("1.1.0") package org.apache.jackrabbit.oak.query.facet; diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/fulltext/package-info.java b/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/fulltext/package-info.java index 8a6835d136..324e2d104a 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/fulltext/package-info.java +++ b/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/fulltext/package-info.java @@ -14,7 +14,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * This package contains fulltext search condition implementations. + */ @Version("1.0.0") package org.apache.jackrabbit.oak.spi.query.fulltext; -import org.osgi.annotation.versioning.Version; \ No newline at end of file +import org.osgi.annotation.versioning.Version; diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/package-info.java b/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/package-info.java index c64316e0b9..63bc0a11c6 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/package-info.java +++ b/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/spi/query/package-info.java @@ -14,6 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +/** + * This package contains oak query index related classes. + */ @Version("1.3.0") package org.apache.jackrabbit.oak.spi.query; diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/package-info.java similarity index 80% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/package-info.java index a6d15dcba6..20887900a2 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes and interfaces which define index and its statistics. + */ +package org.apache.jackrabbit.oak.plugins.index.search; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/binary/package-info.java similarity index 79% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/binary/package-info.java index a6d15dcba6..cd53ac52c7 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/binary/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes related to text extraction from binary sources. + */ +package org.apache.jackrabbit.oak.plugins.index.search.spi.binary; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/package-info.java similarity index 74% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/package-info.java index a6d15dcba6..f471eeb2b1 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/package-info.java @@ -14,7 +14,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes that deal with updating indexes, including how to build indexing backend + * documents (e.g. Lucene and Solr documents) + */ +package org.apache.jackrabbit.oak.plugins.index.search.spi.editor; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/query/package-info.java similarity index 82% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/query/package-info.java index a6d15dcba6..939aaa6973 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/query/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains query index related classes. + */ +package org.apache.jackrabbit.oak.plugins.index.search.spi.query; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/update/package-info.java similarity index 78% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/update/package-info.java index a6d15dcba6..12af97b72b 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/update/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains classes and interfaces which define different refresh policies for indices. + */ +package org.apache.jackrabbit.oak.plugins.index.search.update; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file diff --git a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/util/package-info.java similarity index 82% copy from oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java copy to oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/util/package-info.java index a6d15dcba6..90e33713e5 100644 --- a/oak-query-spi/src/main/java/org/apache/jackrabbit/oak/query/facet/package-info.java +++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/util/package-info.java @@ -14,7 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -@Version("1.1.0") -package org.apache.jackrabbit.oak.query.facet; -import org.osgi.annotation.versioning.Version; +/** + * This package contains various utility classes. + */ +package org.apache.jackrabbit.oak.plugins.index.search.util; + +import org.osgi.annotation.versioning.Version; \ No newline at end of file