Merge branch '29-package-docs' into v2.4.0

Author: greenrobot-team

objectbox-java-api/src/main/java/io/objectbox/annotation/apihint/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2019 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed 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.
+ */
+
+/**
+ * Annotations to mark APIs as for example {@link io.objectbox.annotation.apihint.Internal @Internal}
+ * or {@link io.objectbox.annotation.apihint.Experimental @Experimental}.
+ */
+package io.objectbox.annotation.apihint;

objectbox-java-api/src/main/java/io/objectbox/annotation/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed 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.
+ */
+
+/**
+ * Annotations to mark a class as an {@link io.objectbox.annotation.Entity @Entity},
+ * to specify the {@link io.objectbox.annotation.Id @Id} property,
+ * to create an {@link io.objectbox.annotation.Index @Index} or
+ * a {@link io.objectbox.annotation.Transient @Transient} property.
+ * <p>
+ * For more details look at the documentation of individual classes and
+ * <a href="https://docs.objectbox.io/entity-annotations">docs.objectbox.io/entity-annotations</a>.
+ */
+package io.objectbox.annotation;

objectbox-java-api/src/main/java/io/objectbox/converter/package-info.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed 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.
+ */
+
+/**
+ * For use with {@link io.objectbox.annotation.Convert @Convert}: {@link io.objectbox.converter.PropertyConverter}
+ * to convert custom property types.
+ * <p>
+ * For more details look at the documentation of individual classes and
+ * <a href="https://docs.objectbox.io/advanced/custom-types">docs.objectbox.io/advanced/custom-types</a>.
+ */
+package io.objectbox.converter;

objectbox-java/src/main/java/io/objectbox/exception/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2019 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed 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.
+ */
+
+/**
+ * Various exceptions thrown by ObjectBox.
+ */
+package io.objectbox.exception;

objectbox-java/src/main/java/io/objectbox/package-info.java

@@ -14,6 +14,20 @@
  * limitations under the License.
  */
 
+/**
+ * ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
+ * <p>
+ * The following core classes are the essential interface to ObjectBox:
+ * <ul>
+ * <li>MyObjectBox: Generated by the Gradle plugin, supplies a {@link io.objectbox.BoxStoreBuilder}
+ * to build a BoxStore for your app.</li>
+ * <li>{@link io.objectbox.BoxStore}: The database interface, allows to manage Boxes.</li>
+ * <li>{@link io.objectbox.Box}: Persists and queries for entities, there is one for each entity.</li>
+ * </ul>
+ * <p>
+ * For more details look at the documentation of individual classes and
+ * <a href="https://docs.objectbox.io">docs.objectbox.io</a>.
+ */
 @ParametersAreNonnullByDefault
 package io.objectbox;
 

objectbox-java/src/main/java/io/objectbox/query/package-info.java

@@ -14,6 +14,13 @@
  * limitations under the License.
  */
 
+/**
+ * Classes related to {@link io.objectbox.query.QueryBuilder building}
+ * a {@link io.objectbox.query.Query} or {@link io.objectbox.query.PropertyQuery}.
+ * <p>
+ * For more details look at the documentation of individual classes and
+ * <a href="https://docs.objectbox.io/queries">docs.objectbox.io/queries</a>.
+ */
 @ParametersAreNonnullByDefault
 package io.objectbox.query;
 

objectbox-java/src/main/java/io/objectbox/reactive/package-info.java

@@ -14,6 +14,13 @@
  * limitations under the License.
  */
 
+/**
+ * Classes to {@link io.objectbox.reactive.SubscriptionBuilder configure}
+ * a {@link io.objectbox.reactive.DataSubscription} for observing box or query changes.
+ * <p>
+ * For more details look at the documentation of individual classes and
+ * <a href="https://docs.objectbox.io/data-observers-and-rx">docs.objectbox.io/data-observers-and-rx</a>.
+ */
 @ParametersAreNonnullByDefault
 package io.objectbox.reactive;
 

objectbox-java/src/main/java/io/objectbox/relation/package-info.java

@@ -14,6 +14,13 @@
  * limitations under the License.
  */
 
+/**
+ * Classes to manage {@link io.objectbox.relation.ToOne} and {@link io.objectbox.relation.ToMany}
+ * relations between entities.
+ * <p>
+ * For more details look at the documentation of individual classes and
+ * <a href="https://docs.objectbox.io/relations">docs.objectbox.io/relations</a>.
+ */
 @ParametersAreNonnullByDefault
 package io.objectbox.relation;