From 04bdd343d7caee6dc98eb2cae1788fb82209e941 Mon Sep 17 00:00:00 2001 From: Kenneth Geisshirt Date: Thu, 17 May 2018 11:51:45 +0200 Subject: [PATCH 1/2] Don't abuse jsdoc --- docs/collection.js | 2 -- docs/list.js | 2 -- docs/object.js | 4 +--- docs/permission.js | 2 -- docs/results.js | 2 -- docs/sync.js | 12 ------------ 6 files changed, 1 insertion(+), 23 deletions(-) diff --git a/docs/collection.js b/docs/collection.js index 35050bc3..da289d44 100644 --- a/docs/collection.js +++ b/docs/collection.js @@ -29,8 +29,6 @@ * objects which matched the query when the enumeration is begun, even if some of them are * deleted or modified to be excluded by the filter during the enumeration. * - * @class - * @name Realm.Collection * @memberof Realm * @since 0.11.0 */ diff --git a/docs/list.js b/docs/list.js index 877333b1..500e4e4c 100644 --- a/docs/list.js +++ b/docs/list.js @@ -26,8 +26,6 @@ * Realm#write write} transaction. * * @extends Realm.Collection - * @class - * @name Realm.List * @memberof Realm */ class List extends Collection { diff --git a/docs/object.js b/docs/object.js index 229c8291..24d1b800 100644 --- a/docs/object.js +++ b/docs/object.js @@ -21,11 +21,9 @@ * was specified that does **not** inherit from this class. * @memberof Realm * @since 0.12.0 - * @class - * @name Realm.Object - * @memberof Realm */ class Object { + /** * Checks if this object has not been deleted and is part of a valid Realm. * @returns {boolean} indicating if the object can be safely accessed. diff --git a/docs/permission.js b/docs/permission.js index afc43e12..bdefc4f5 100644 --- a/docs/permission.js +++ b/docs/permission.js @@ -330,8 +330,6 @@ 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 - * @class - * @name Realm.Sync.Permission.User * @memberof Realm.Sync.Permission */ class User { diff --git a/docs/results.js b/docs/results.js index 00420d0e..245cda4e 100644 --- a/docs/results.js +++ b/docs/results.js @@ -24,8 +24,6 @@ * (and listener callbacks added through {@link Realm.Results#addListener addListener()} * will thus never be called). * - * @class - * @name Realm.Results * @extends Realm.Collection * @memberof Realm */ diff --git a/docs/sync.js b/docs/sync.js index e02e4fd1..07c0b120 100644 --- a/docs/sync.js +++ b/docs/sync.js @@ -87,7 +87,6 @@ * is a {Realm~Configuration} which refers to it. You can open it as a local, read-only Realm, and * copy objects to a new synced Realm. * - * @name Realm.Sync * @memberof Realm */ class Sync { @@ -192,8 +191,6 @@ class Sync { * resolved). The Realms supplied by the change event do not need to be * explicitly closed. * - * @class - * @name Realm.Sync.ChangeEvent * @memberof Realm.Sync */ class ChangeEvent { @@ -252,8 +249,6 @@ class ChangeEvent { /** * Class that describes authentication errors in the Realm Object Server - * @class - * @name Realm.Sync.AuthError * @memberof Realm.Sync */ class AuthError extends Error { @@ -272,8 +267,6 @@ class AuthError extends Error { /** * Describes an error when an incompatible synced Realm is opened. The old version of the Realm can be accessed in readonly mode using the configuration() member - * @class - * @name Realm.Sync.IncompatibleSyncedRealmError * @memberof Realm.Sync */ class IncompatibleSyncedRealmError { @@ -291,8 +284,6 @@ class IncompatibleSyncedRealmError { /** * Class for logging in and managing Sync users. - * @class - * @name Realm.Sync.User * @memberof Realm.Sync */ class User { @@ -596,8 +587,6 @@ class Session { /** * An object encapsulating partial sync subscriptions. - * @class - * @name Realm.Sync.Subscription * @memberof Realm.Sync */ class Subscription { @@ -722,7 +711,6 @@ class Worker { /** * Custom Data Connectors. - * @name Realm.Sync.Adapter * @memberof Realm.Sync */ class Adapter { From 38ac25a2afcbf8d7f41867e76b7fcb52c30fa2f3 Mon Sep 17 00:00:00 2001 From: Kenneth Geisshirt Date: Thu, 17 May 2018 11:52:20 +0200 Subject: [PATCH 2/2] Updating to latest jsdoc template --- docs/jsdoc-template | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/jsdoc-template b/docs/jsdoc-template index 441d8a45..682e21fe 160000 --- a/docs/jsdoc-template +++ b/docs/jsdoc-template @@ -1 +1 @@ -Subproject commit 441d8a45eb39d454ea612251bf2adb60473ede70 +Subproject commit 682e21fe456b39169ff2d4f3f7ffc24d04cb84fd