diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d2a600a..f6bd8858 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ X.Y.Z Release notes ### Internals * Upgraded to Realm Core v5.6.3. * Upgraded to Realm Sync v3.5.8. +* Fixed class names in API documentation. 2.10.0 Release notes (2018-6-19) diff --git a/docs/permission.js b/docs/permission.js index 0cc8523b..ea8545db 100644 --- a/docs/permission.js +++ b/docs/permission.js @@ -243,7 +243,7 @@ class PermissionOfferResponse { * the properties of Permission depend on what the permission is applied to, and so are * left undocumented here. * @since 2.3.0 - * @memberof Realm.Sync + * @memberof Realm.Permissions */ class Permission { @@ -253,7 +253,7 @@ class Permission { * objects/classes/realms which use this Permission. * * This property cannot be modified once set. - * @type {Role} + * @type {Realm.Permissions.Role} */ get role() {} @@ -321,7 +321,7 @@ class Permission { * a Realm, and can also be created manually if you wish to grant permissions to a user * which has not yet connected to this Realm. * @since 2.3.0 - * @memberof Realm.Sync.Permission + * @memberof Realm.Permissions */ class User { /** @@ -342,7 +342,7 @@ class User { * connect to the Realm are automatically added to it. Any other roles you wish to use are * managed as normal Realm objects. * @since 2.3.0 - * @memberof Realm.Sync.Permission + * @memberof Realm.Permissions */ class Role { /** @@ -353,7 +353,7 @@ class Role { /** * The users which belong to the role. - * @type {Array} + * @type {Array} */ get members() {} } @@ -364,7 +364,7 @@ class Role { * An instance of this object is automatically created in the Realm for class in your schema, * and should not be created manually. * @since 2.3.0 - * @memberof Realm.Sync.Permission + * @memberof Realm.Permissions */ class Class { /** @@ -375,7 +375,7 @@ class Class { /** * The permissions for this class. - * @type {Array} + * @type {Array} */ get permissions() {} } @@ -386,12 +386,12 @@ class Class { * An object of this type is automatically created in the Realm for you, and more objects * cannot be created manually. * @since 2.3.0 - * @memberof Realm.Sync.Permission + * @memberof Realm.Permissions */ class Realm { /** * The permissions for the Realm. - * @type {Array} + * @type {Array} */ get permissions() {} }