Update yokedox javadoc for v10.11 (#1941)

* Update javadoc v10.11 * Add yokedox config and external links
mongodb · May 23, 2022 · 5da8d95 · 5da8d95
1 parent af0242d
commit 5da8d95
Show file tree

Hide file tree

Showing 148 changed files with 26,237 additions and 4,656 deletions.
diff --git a/.yokedox.json b/.yokedox.json
@@ -0,0 +1,21 @@
+{
+  "externalEntityPatterns": [
+    {
+      "from": "^java\\.",
+      "toPrefix": "https://docs.oracle.com/javase/7/docs/api/",
+      "toSuffix": ".html"
+    },
+    {
+      "from": "^io\\.reactivex\\.",
+      "toPrefix": "http://reactivex.io/RxJava/javadoc/"
+    },
+    {
+      "from": "^android\\.",
+      "toPrefix": "https://developer.android.com/reference/"
+    },
+    {
+      "from": "^org\\.bson\\.",
+      "toPrefix": "https://www.javadoc.io/doc/org.mongodb/bson/3.12.1/"
+    }
+  ]
+}
diff --git a/source/sdk/java/api/index.txt b/source/sdk/java/api/index.txt
@@ -0,0 +1,63 @@
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+
+
+API Reference
+^^^^^^^^^^^^^
+
+.. toctree::
+   :titlesonly:
+   :hidden:
+
+
+   io.realm </sdk/java/api/io/realm>
+   io.realm.annotations </sdk/java/api/io/realm/annotations>
+   io.realm.coroutines </sdk/java/api/io/realm/coroutines>
+   io.realm.exceptions </sdk/java/api/io/realm/exceptions>
+   io.realm.gradle </sdk/java/api/io/realm/gradle>
+   io.realm.log </sdk/java/api/io/realm/log>
+   io.realm.mongodb </sdk/java/api/io/realm/mongodb>
+   io.realm.mongodb.auth </sdk/java/api/io/realm/mongodb/auth>
+   io.realm.mongodb.functions </sdk/java/api/io/realm/mongodb/functions>
+   io.realm.mongodb.log.obfuscator </sdk/java/api/io/realm/mongodb/log/obfuscator>
+   io.realm.mongodb.mongo </sdk/java/api/io/realm/mongodb/mongo>
+   io.realm.mongodb.mongo.events </sdk/java/api/io/realm/mongodb/mongo/events>
+   io.realm.mongodb.mongo.iterable </sdk/java/api/io/realm/mongodb/mongo/iterable>
+   io.realm.mongodb.mongo.options </sdk/java/api/io/realm/mongodb/mongo/options>
+   io.realm.mongodb.mongo.result </sdk/java/api/io/realm/mongodb/mongo/result>
+   io.realm.mongodb.push </sdk/java/api/io/realm/mongodb/push>
+   io.realm.mongodb.sync </sdk/java/api/io/realm/mongodb/sync>
+   io.realm.rx </sdk/java/api/io/realm/rx>
+   io.realm.transformer </sdk/java/api/io/realm/transformer>
+
+
+
+| 
+
+- :ref:`io.realm <io_realm>` 
+- :ref:`io.realm.annotations <io_realm_annotations>` 
+- :ref:`io.realm.coroutines <io_realm_coroutines>` 
+- :ref:`io.realm.exceptions <io_realm_exceptions>` 
+- :ref:`io.realm.gradle <io_realm_gradle>` 
+- :ref:`io.realm.log <io_realm_log>` 
+- :ref:`io.realm.mongodb <io_realm_mongodb>` 
+- :ref:`io.realm.mongodb.auth <io_realm_mongodb_auth>` 
+- :ref:`io.realm.mongodb.functions <io_realm_mongodb_functions>` 
+- :ref:`io.realm.mongodb.log.obfuscator <io_realm_mongodb_log_obfuscator>` 
+- :ref:`io.realm.mongodb.mongo <io_realm_mongodb_mongo>` 
+- :ref:`io.realm.mongodb.mongo.events <io_realm_mongodb_mongo_events>` 
+- :ref:`io.realm.mongodb.mongo.iterable <io_realm_mongodb_mongo_iterable>` 
+- :ref:`io.realm.mongodb.mongo.options <io_realm_mongodb_mongo_options>` 
+- :ref:`io.realm.mongodb.mongo.result <io_realm_mongodb_mongo_result>` 
+- :ref:`io.realm.mongodb.push <io_realm_mongodb_push>` 
+- :ref:`io.realm.mongodb.sync <io_realm_mongodb_sync>` 
+- :ref:`io.realm.rx <io_realm_rx>` 
+- :ref:`io.realm.transformer <io_realm_transformer>` 
+
+
+
diff --git a/source/sdk/java/api/io/realm.txt b/source/sdk/java/api/io/realm.txt
@@ -16,6 +16,7 @@ io.realm
 
 
    Case </sdk/java/api/io/realm/Case>
+   CollectionUtils </sdk/java/api/io/realm/CollectionUtils>
    CompactOnLaunchCallback </sdk/java/api/io/realm/CompactOnLaunchCallback>
    DefaultCompactOnLaunchCallback </sdk/java/api/io/realm/DefaultCompactOnLaunchCallback>
    DynamicRealm </sdk/java/api/io/realm/DynamicRealm>
@@ -28,6 +29,8 @@ io.realm
    FieldAttribute </sdk/java/api/io/realm/FieldAttribute>
    FrozenPendingRow </sdk/java/api/io/realm/FrozenPendingRow>
    ImportFlag </sdk/java/api/io/realm/ImportFlag>
+   MapChangeListener </sdk/java/api/io/realm/MapChangeListener>
+   MapChangeSet </sdk/java/api/io/realm/MapChangeSet>
    MutableRealmInteger </sdk/java/api/io/realm/MutableRealmInteger>
    ObjectChangeSet </sdk/java/api/io/realm/ObjectChangeSet>
    OrderedCollectionChangeSet </sdk/java/api/io/realm/OrderedCollectionChangeSet>
@@ -43,13 +46,19 @@ io.realm
    Realm.Transaction.Callback </sdk/java/api/io/realm/Realm/Transaction/Callback>
    Realm.Transaction.OnError </sdk/java/api/io/realm/Realm/Transaction/OnError>
    Realm.Transaction.OnSuccess </sdk/java/api/io/realm/Realm/Transaction/OnSuccess>
+   RealmAny </sdk/java/api/io/realm/RealmAny>
+   RealmAny.Type </sdk/java/api/io/realm/RealmAny/Type>
+   RealmAnyNativeFunctionsImpl </sdk/java/api/io/realm/RealmAnyNativeFunctionsImpl>
+   RealmAnyOperator </sdk/java/api/io/realm/RealmAnyOperator>
    RealmAsyncTask </sdk/java/api/io/realm/RealmAsyncTask>
    RealmChangeListener </sdk/java/api/io/realm/RealmChangeListener>
    RealmCollection </sdk/java/api/io/realm/RealmCollection>
    RealmConfiguration </sdk/java/api/io/realm/RealmConfiguration>
    RealmConfiguration.Builder </sdk/java/api/io/realm/RealmConfiguration/Builder>
+   RealmDictionary </sdk/java/api/io/realm/RealmDictionary>
    RealmFieldType </sdk/java/api/io/realm/RealmFieldType>
    RealmList </sdk/java/api/io/realm/RealmList>
+   RealmMap </sdk/java/api/io/realm/RealmMap>
    RealmMigration </sdk/java/api/io/realm/RealmMigration>
    RealmModel </sdk/java/api/io/realm/RealmModel>
    RealmObject </sdk/java/api/io/realm/RealmObject>
@@ -59,13 +68,17 @@ io.realm
    RealmQuery </sdk/java/api/io/realm/RealmQuery>
    RealmResults </sdk/java/api/io/realm/RealmResults>
    RealmSchema </sdk/java/api/io/realm/RealmSchema>
+   RealmSet </sdk/java/api/io/realm/RealmSet>
+   SetChangeListener </sdk/java/api/io/realm/SetChangeListener>
+   SetChangeSet </sdk/java/api/io/realm/SetChangeSet>
    Sort </sdk/java/api/io/realm/Sort>
 
 
 
 | 
 
 - :ref:`io.realm.Case <io_realm_Case>` 
+- :ref:`io.realm.CollectionUtils <io_realm_CollectionUtils>` 
 - :ref:`io.realm.CompactOnLaunchCallback <io_realm_CompactOnLaunchCallback>` 
 - :ref:`io.realm.DefaultCompactOnLaunchCallback <io_realm_DefaultCompactOnLaunchCallback>` 
 - :ref:`io.realm.DynamicRealm <io_realm_DynamicRealm>` 
@@ -78,6 +91,8 @@ io.realm
 - :ref:`io.realm.FieldAttribute <io_realm_FieldAttribute>` 
 - :ref:`io.realm.FrozenPendingRow <io_realm_FrozenPendingRow>` 
 - :ref:`io.realm.ImportFlag <io_realm_ImportFlag>` 
+- :ref:`io.realm.MapChangeListener <io_realm_MapChangeListener>` 
+- :ref:`io.realm.MapChangeSet <io_realm_MapChangeSet>` 
 - :ref:`io.realm.MutableRealmInteger <io_realm_MutableRealmInteger>` 
 - :ref:`io.realm.ObjectChangeSet <io_realm_ObjectChangeSet>` 
 - :ref:`io.realm.OrderedCollectionChangeSet <io_realm_OrderedCollectionChangeSet>` 
@@ -93,13 +108,19 @@ io.realm
 - :ref:`io.realm.Realm.Transaction.Callback <io_realm_Realm_Transaction_Callback>` 
 - :ref:`io.realm.Realm.Transaction.OnError <io_realm_Realm_Transaction_OnError>` 
 - :ref:`io.realm.Realm.Transaction.OnSuccess <io_realm_Realm_Transaction_OnSuccess>` 
+- :ref:`io.realm.RealmAny <io_realm_RealmAny>` 
+- :ref:`io.realm.RealmAny.Type <io_realm_RealmAny_Type>` 
+- :ref:`io.realm.RealmAnyNativeFunctionsImpl <io_realm_RealmAnyNativeFunctionsImpl>` 
+- :ref:`io.realm.RealmAnyOperator <io_realm_RealmAnyOperator>` 
 - :ref:`io.realm.RealmAsyncTask <io_realm_RealmAsyncTask>` 
 - :ref:`io.realm.RealmChangeListener <io_realm_RealmChangeListener>` 
 - :ref:`io.realm.RealmCollection <io_realm_RealmCollection>` 
 - :ref:`io.realm.RealmConfiguration <io_realm_RealmConfiguration>` 
 - :ref:`io.realm.RealmConfiguration.Builder <io_realm_RealmConfiguration_Builder>` 
+- :ref:`io.realm.RealmDictionary <io_realm_RealmDictionary>` 
 - :ref:`io.realm.RealmFieldType <io_realm_RealmFieldType>` 
 - :ref:`io.realm.RealmList <io_realm_RealmList>` 
+- :ref:`io.realm.RealmMap <io_realm_RealmMap>` 
 - :ref:`io.realm.RealmMigration <io_realm_RealmMigration>` 
 - :ref:`io.realm.RealmModel <io_realm_RealmModel>` 
 - :ref:`io.realm.RealmObject <io_realm_RealmObject>` 
@@ -109,6 +130,9 @@ io.realm
 - :ref:`io.realm.RealmQuery <io_realm_RealmQuery>` 
 - :ref:`io.realm.RealmResults <io_realm_RealmResults>` 
 - :ref:`io.realm.RealmSchema <io_realm_RealmSchema>` 
+- :ref:`io.realm.RealmSet <io_realm_RealmSet>` 
+- :ref:`io.realm.SetChangeListener <io_realm_SetChangeListener>` 
+- :ref:`io.realm.SetChangeSet <io_realm_SetChangeSet>` 
 - :ref:`io.realm.Sort <io_realm_Sort>` 
 
 

diff --git a/source/sdk/java/api/io/realm/Case.txt b/source/sdk/java/api/io/realm/Case.txt
@@ -18,8 +18,8 @@ io.realm
 ========
 
 
- | `java.lang.Object <https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html>`__ 
- | 		`java.lang.Enum <https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html>`__ 
+ | `java.lang.Object <https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html>`__ 
+ | 		`java.lang.Enum <https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html>`__ 
  | 					io.realm.Case
 
 
@@ -98,7 +98,7 @@ Method Summary
 
    * - public static :ref:`Case <io_realm_Case>` 
      - | :ref:`valueOf <io_realm_Case_valueOf>` (
-       |  `String <https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>`__  name
+       |  `String <https://docs.oracle.com/javase/7/docs/api/java/lang/String.html>`__  name
        | )
 
 
@@ -125,8 +125,8 @@ Inherited Methods
 
 
 
-- Methods inherited from class `java.lang.Object <https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html>`__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` 
-- Methods inherited from class `java.lang.Enum <https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html>`__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` 
+- Methods inherited from class `java.lang.Object <https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html>`__ : ``getClass`` , ``hashCode`` , ``equals`` , ``clone`` , ``toString`` , ``notify`` , ``notifyAll`` , ``wait`` , ``wait`` , ``wait`` , ``finalize`` 
+- Methods inherited from class `java.lang.Enum <https://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html>`__ : ``name`` , ``ordinal`` , ``toString`` , ``equals`` , ``hashCode`` , ``clone`` , ``compareTo`` , ``getDeclaringClass`` , ``valueOf`` , ``finalize`` 
 
 
 
@@ -249,7 +249,7 @@ valueOf
    :header-rows: 1
 
    * - | public static :ref:`Case <io_realm_Case>`  :ref:`valueOf <io_realm_Case_valueOf>` (
-       |  `String <https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>`__  name
+       |  `String <https://docs.oracle.com/javase/7/docs/api/java/lang/String.html>`__  name
        | )