Javadoc: add overview.

greenrobot-team · greenrobot · commit 770a5919d80e · 2020-08-13T14:30:32.000+02:00
diff --git a/objectbox-java/build.gradle b/objectbox-java/build.gradle
@@ -63,6 +63,7 @@ task javadocForWeb(type: Javadoc) {
     destinationDir = file(javadocForWebDir)
 
     title = "ObjectBox Java ${version} API"
+    options.overview = "$projectDir/src/web/overview.html"
     options.bottom = 'Available under the Apache License, Version 2.0 - <i>Copyright &#169; 2017-2020 <a href="http://objectbox.io/">ObjectBox Ltd</a>. All Rights Reserved.</i>'
 
     doLast {
diff --git a/objectbox-java/src/web/overview.html b/objectbox-java/src/web/overview.html
@@ -0,0 +1,7 @@
+<HTML>
+<BODY>
+ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
+<p>
+    Additional documentation is available at <a href="https://docs.objectbox.io">docs.objectbox.io</a>.
+</BODY>
+</HTML>

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<HTML>
 +<BODY>
 +ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
 +<p>
 +    Additional documentation is available at <a href="https://docs.objectbox.io">docs.objectbox.io</a>.
 +</BODY>
 +</HTML>