Don't abuse jsdoc
This commit is contained in:
parent
faa0ed304b
commit
04bdd343d7
|
@ -29,8 +29,6 @@
|
||||||
* objects which matched the query when the enumeration is begun, even if some of them are
|
* 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.
|
* deleted or modified to be excluded by the filter during the enumeration.
|
||||||
*
|
*
|
||||||
* @class
|
|
||||||
* @name Realm.Collection
|
|
||||||
* @memberof Realm
|
* @memberof Realm
|
||||||
* @since 0.11.0
|
* @since 0.11.0
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -26,8 +26,6 @@
|
||||||
* Realm#write write} transaction.
|
* Realm#write write} transaction.
|
||||||
*
|
*
|
||||||
* @extends Realm.Collection
|
* @extends Realm.Collection
|
||||||
* @class
|
|
||||||
* @name Realm.List
|
|
||||||
* @memberof Realm
|
* @memberof Realm
|
||||||
*/
|
*/
|
||||||
class List extends Collection {
|
class List extends Collection {
|
||||||
|
|
|
@ -21,11 +21,9 @@
|
||||||
* was specified that does **not** inherit from this class.
|
* was specified that does **not** inherit from this class.
|
||||||
* @memberof Realm
|
* @memberof Realm
|
||||||
* @since 0.12.0
|
* @since 0.12.0
|
||||||
* @class
|
|
||||||
* @name Realm.Object
|
|
||||||
* @memberof Realm
|
|
||||||
*/
|
*/
|
||||||
class Object {
|
class Object {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if this object has not been deleted and is part of a valid Realm.
|
* 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.
|
* @returns {boolean} indicating if the object can be safely accessed.
|
||||||
|
|
|
@ -330,8 +330,6 @@ class Permission {
|
||||||
* a Realm, and can also be created manually if you wish to grant permissions to a user
|
* 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.
|
* which has not yet connected to this Realm.
|
||||||
* @since 2.3.0
|
* @since 2.3.0
|
||||||
* @class
|
|
||||||
* @name Realm.Sync.Permission.User
|
|
||||||
* @memberof Realm.Sync.Permission
|
* @memberof Realm.Sync.Permission
|
||||||
*/
|
*/
|
||||||
class User {
|
class User {
|
||||||
|
|
|
@ -24,8 +24,6 @@
|
||||||
* (and listener callbacks added through {@link Realm.Results#addListener addListener()}
|
* (and listener callbacks added through {@link Realm.Results#addListener addListener()}
|
||||||
* will thus never be called).
|
* will thus never be called).
|
||||||
*
|
*
|
||||||
* @class
|
|
||||||
* @name Realm.Results
|
|
||||||
* @extends Realm.Collection
|
* @extends Realm.Collection
|
||||||
* @memberof Realm
|
* @memberof Realm
|
||||||
*/
|
*/
|
||||||
|
|
12
docs/sync.js
12
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
|
* 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.
|
* copy objects to a new synced Realm.
|
||||||
*
|
*
|
||||||
* @name Realm.Sync
|
|
||||||
* @memberof Realm
|
* @memberof Realm
|
||||||
*/
|
*/
|
||||||
class Sync {
|
class Sync {
|
||||||
|
@ -192,8 +191,6 @@ class Sync {
|
||||||
* resolved). The Realms supplied by the change event do not need to be
|
* resolved). The Realms supplied by the change event do not need to be
|
||||||
* explicitly closed.
|
* explicitly closed.
|
||||||
*
|
*
|
||||||
* @class
|
|
||||||
* @name Realm.Sync.ChangeEvent
|
|
||||||
* @memberof Realm.Sync
|
* @memberof Realm.Sync
|
||||||
*/
|
*/
|
||||||
class ChangeEvent {
|
class ChangeEvent {
|
||||||
|
@ -252,8 +249,6 @@ class ChangeEvent {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class that describes authentication errors in the Realm Object Server
|
* Class that describes authentication errors in the Realm Object Server
|
||||||
* @class
|
|
||||||
* @name Realm.Sync.AuthError
|
|
||||||
* @memberof Realm.Sync
|
* @memberof Realm.Sync
|
||||||
*/
|
*/
|
||||||
class AuthError extends Error {
|
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
|
* 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
|
* @memberof Realm.Sync
|
||||||
*/
|
*/
|
||||||
class IncompatibleSyncedRealmError {
|
class IncompatibleSyncedRealmError {
|
||||||
|
@ -291,8 +284,6 @@ class IncompatibleSyncedRealmError {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class for logging in and managing Sync users.
|
* Class for logging in and managing Sync users.
|
||||||
* @class
|
|
||||||
* @name Realm.Sync.User
|
|
||||||
* @memberof Realm.Sync
|
* @memberof Realm.Sync
|
||||||
*/
|
*/
|
||||||
class User {
|
class User {
|
||||||
|
@ -596,8 +587,6 @@ class Session {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An object encapsulating partial sync subscriptions.
|
* An object encapsulating partial sync subscriptions.
|
||||||
* @class
|
|
||||||
* @name Realm.Sync.Subscription
|
|
||||||
* @memberof Realm.Sync
|
* @memberof Realm.Sync
|
||||||
*/
|
*/
|
||||||
class Subscription {
|
class Subscription {
|
||||||
|
@ -722,7 +711,6 @@ class Worker {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Custom Data Connectors.
|
* Custom Data Connectors.
|
||||||
* @name Realm.Sync.Adapter
|
|
||||||
* @memberof Realm.Sync
|
* @memberof Realm.Sync
|
||||||
*/
|
*/
|
||||||
class Adapter {
|
class Adapter {
|
||||||
|
|
Loading…
Reference in New Issue