OAK-8892 Add javadoc to package-info files

git-svn-id: https://svn.apache.org/repos/asf/jackrabbit/oak/trunk@1873977 13f79535-47bb-0310-9956-ffa450edef68

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 lucene directory related implementations.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.directory;
+
+import org.osgi.annotation.versioning.Version;

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/hybrid/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 classes related to lucene hybrid indices that forms the basis of NRT indexing.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.hybrid;
+
+import org.osgi.annotation.versioning.Version;

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/package-info.java

@@ -0,0 +1,27 @@
+/*
+ * 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 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>.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.property;
+
+import org.osgi.annotation.versioning.Version;

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/reader/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 lucene index reader related classes.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.reader;
+
+import org.osgi.annotation.versioning.Version;

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/fv/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 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.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.util.fv;
+
+import org.osgi.annotation.versioning.Version;

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 various indexing and search related helpers.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.util;
+
+import org.osgi.annotation.versioning.Version;

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 classes related lucene index writing.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.lucene.writer;
+
+import org.osgi.annotation.versioning.Version;

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;
 

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;
+import org.osgi.annotation.versioning.Version;

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;
 

oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 classes and interfaces which define index and its statistics.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.search;
+
+import org.osgi.annotation.versioning.Version;

oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/binary/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 classes related to text extraction from binary sources.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.search.spi.binary;
+
+import org.osgi.annotation.versioning.Version;

oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/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 classes that deal with updating indexes, including how to build indexing backend
+ * documents (e.g. Lucene and Solr documents)
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.search.spi.editor;
+
+import org.osgi.annotation.versioning.Version;

oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/query/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 query index related classes.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.search.spi.query;
+
+import org.osgi.annotation.versioning.Version;

oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/update/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 classes and interfaces which define different refresh policies for indices.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.search.update;
+
+import org.osgi.annotation.versioning.Version;

oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/util/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * 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 various utility classes.
+ */
+@Version("1.0.0")
+package org.apache.jackrabbit.oak.plugins.index.search.util;
+
+import org.osgi.annotation.versioning.Version;