Merge pull request #1856 from realm/kneth/fix-jsdoc

Fixing JS doc + template
This commit is contained in:
Kenneth Geisshirt 2018-06-12 09:36:19 +02:00 committed by GitHub
commit 0b7aed2885
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 1 additions and 18 deletions

@ -1 +1 @@
Subproject commit 441d8a45eb39d454ea612251bf2adb60473ede70 Subproject commit 682e21fe456b39169ff2d4f3f7ffc24d04cb84fd

View File

@ -28,8 +28,6 @@
* materialized for the affected Realm files and the affected user. * materialized for the affected Realm files and the affected user.
* Once the request has been processed, the Status, StatusMessage, and * Once the request has been processed, the Status, StatusMessage, and
* ErrorCode will be updated accordingly. * ErrorCode will be updated accordingly.
* @class
* @name Realm.Sync.User.PermissionChange
* @memberof Realm.Sync.User * @memberof Realm.Sync.User
*/ */
class PermissionChange { class PermissionChange {
@ -107,8 +105,6 @@ class PermissionChange {
* with users you wish to grant permissions to. * with users you wish to grant permissions to.
* If the request has failed, statusMessage will be updated with relevant information about the * If the request has failed, statusMessage will be updated with relevant information about the
* failure and statusCode will be set. * failure and statusCode will be set.
* @class
* @name Realm.Sync.User.PermissionOffer
* @memberof Realm.Sync.User * @memberof Realm.Sync.User
*/ */
class PermissionOffer { class PermissionOffer {
@ -190,8 +186,6 @@ class PermissionOffer {
* to connect to the Realm. * to connect to the Realm.
* If the request has failed, the statusMessage will be updated with relevant information about the * If the request has failed, the statusMessage will be updated with relevant information about the
* failure and statusCode will be set. * failure and statusCode will be set.
* @class
* @name Realm.Sync.User.PermissionOfferResponse
* @memberof Realm.Sync.User * @memberof Realm.Sync.User
*/ */
class PermissionOfferResponse { class PermissionOfferResponse {
@ -249,9 +243,6 @@ class PermissionOfferResponse {
* the properties of Permission depend on what the permission is applied to, and so are * the properties of Permission depend on what the permission is applied to, and so are
* left undocumented here. * left undocumented here.
* @since 2.3.0 * @since 2.3.0
*
* @class
* @name Realm.Sync.Permission
* @memberof Realm.Sync * @memberof Realm.Sync
*/ */
class Permission { class Permission {
@ -351,8 +342,6 @@ class User {
* connect to the Realm are automatically added to it. Any other roles you wish to use are * connect to the Realm are automatically added to it. Any other roles you wish to use are
* managed as normal Realm objects. * managed as normal Realm objects.
* @since 2.3.0 * @since 2.3.0
* @class
* @name Realm.Sync.Permission.Role
* @memberof Realm.Sync.Permission * @memberof Realm.Sync.Permission
*/ */
class Role { class Role {
@ -375,8 +364,6 @@ class Role {
* An instance of this object is automatically created in the Realm for class in your schema, * An instance of this object is automatically created in the Realm for class in your schema,
* and should not be created manually. * and should not be created manually.
* @since 2.3.0 * @since 2.3.0
* @class
* @name Realm.Sync.Permission.Class
* @memberof Realm.Sync.Permission * @memberof Realm.Sync.Permission
*/ */
class Class { class Class {
@ -399,8 +386,6 @@ class Class {
* An object of this type is automatically created in the Realm for you, and more objects * An object of this type is automatically created in the Realm for you, and more objects
* cannot be created manually. * cannot be created manually.
* @since 2.3.0 * @since 2.3.0
* @class
* @name Realm.Sync.Permission.Realm
* @memberof Realm.Sync.Permission * @memberof Realm.Sync.Permission
*/ */
class Realm { class Realm {

View File

@ -541,8 +541,6 @@ class User {
* client (and a local Realm file on disk), and the server (and a remote Realm at a given URL stored on a Realm Object Server). * client (and a local Realm file on disk), and the server (and a remote Realm at a given URL stored on a Realm Object Server).
* Sessions are always created by the SDK and vended out through various APIs. The lifespans of sessions * Sessions are always created by the SDK and vended out through various APIs. The lifespans of sessions
* associated with Realms are managed automatically. * associated with Realms are managed automatically.
* @class
* @name Realm.Sync.Session
* @memberof Realm.Sync * @memberof Realm.Sync
*/ */
class Session { class Session {