9258d95550
Adapter Docs ( #930 )
...
* adapter docs
* fix undefined bug
2017-05-18 13:40:25 +02:00
22d4b2e391
Fix doc mistake ( #1028 )
...
* Fix doc mistake
* Remove throw doc in Realm.open
2017-05-18 13:11:51 +02:00
57414f641d
Update docs for Realm.open and Realm.openAsync ( #1027 )
...
* Update docs for Realm.open and Realm.openAsync
* Update realm.js
2017-05-18 12:40:26 +02:00
f6564ca68f
Add the variables to the syncConfig
2017-05-05 13:50:45 +02:00
c4535bdf1a
Improve api docs ( #920 )
...
* Set docs title in configuration
* Add markdown plugin to jsdoc
* Add query language tutorial to docs
* jsdoc template submodule updated
* Add query docs
* Document placeholders and composition operators
* Add logo
* Add note about boolean checks
* Fixes as per PR comments
2017-03-22 12:54:35 +01:00
aa38d28eb0
Two more indentation fixes
2017-03-20 10:43:42 +01:00
1bdc50ebf6
Fix indentation in sync docs source
2017-03-20 10:40:56 +01:00
94f8d5a891
Add optional userInfo param to registerWithProvider ( #915 )
...
* Add optional userInfo param to registerWithProvider
* Fixes per PR comments
2017-03-17 14:13:03 +01:00
04bb250208
Fix method name in sync docs ( #898 )
2017-03-08 11:21:28 +01:00
70437745f0
Add Session and some missing User docs ( #828 )
...
* Add Session and some missing User docs
* Remove accidentally pasted line
* Add permissions docs
* Respond to PR comments
* Remove docs for user.create
2017-02-01 21:45:55 +01:00
408f5588f8
Add Permissions models and User Management Realm API ( #824 )
...
* Add Permissions models and User Management Realm API
* docs and changelog
* fix bad merge
* add test
* fix jsdoc annotation
* rename permissions to management schema
2017-01-31 22:56:09 +01:00
02d51d6efe
doc additions ( #724 )
...
* doc additions
* Update sync.js
* Update sync.js
Mirror previous update to call parameter in callback `change_event` to match classname
2016-12-20 17:00:39 +01:00
3fb20537b5
update notifier docs
2016-12-06 17:42:15 +01:00
8d5acd7da5
Fix docs and test according to new api
2016-11-16 13:36:41 +01:00
bfce11918b
temporarily remove sync docs
2016-11-15 10:48:15 -08:00
06b27bf8c0
Add documentation for new methods
2016-11-15 05:19:36 -08:00
06d277aacd
Bumped version of ESLint, added eslinting of specs, make all linting pass
2016-11-14 10:48:50 -08:00
14e75f12bc
Documentation for .all and .current
2016-11-11 14:54:12 -08:00
622482029a
Pass AuthError in Realm.Sync.User methods callbacks ( #619 )
...
* Pass AuthError in Realm.Sync.User methods callbacks
The new Realm.Sync.AuthError class exposes properties common to the Problem family of classes in the Realm Object Server
* extract AuthError in a separate file
* whitespace
2016-10-25 00:12:12 +02:00
9d0df0de3d
Sync and fine grained notifications
2016-10-04 15:07:14 -07:00
ab05c5f732
Add introduced version to objectForPrimaryKey doc
2016-06-17 02:38:09 -07:00
979c035dbb
Add isValid() method doc for collections
2016-06-16 17:50:30 -07:00
3c657c3bbf
Update docs and CHANGELOG with objectForPrimaryKey
2016-06-03 16:59:50 -07:00
bd863f7590
Remove qualification about date precision in API docs
2016-05-19 13:33:00 -07:00
9fff367ce0
Reword close() API doc based on PR feedback
2016-05-04 11:47:11 -07:00
4cecb0a612
Add close() method API doc
2016-05-04 02:39:06 -07:00
77a55ee024
Add API docs for the schema property
2016-05-02 18:28:54 -07:00
02dfed99bd
Add API docs for migration functions
2016-05-02 13:49:40 -07:00
15b69e381d
Add API docs for readOnly
2016-05-02 13:21:02 -07:00
f59e1d972c
API doc update for Realm.Object class
2016-05-02 13:12:49 -07:00
b50870b040
API doc updates for path and schemaVersion properties
2016-05-02 13:12:49 -07:00
0e74362e4c
Merge pull request #340 from realm/sk-collection
...
Make List and Results inherit from Collection
2016-03-21 15:27:18 -07:00
d18ea5630d
Adjust some of the Collection API docs
2016-03-21 15:13:55 -07:00
dc5d9e80f1
tweak docs
2016-03-21 13:34:34 -07:00
2d6360e1f2
update docs
2016-03-21 13:34:34 -07:00
95ac0594df
Add Realm.schemaVersion API doc
...
This may need to be adjusted depending on the decisions surrounding this API.
2016-03-21 13:34:12 -07:00
1b0ec38339
Update realm.js
2016-03-21 13:26:33 -07:00
80c532cf3e
docs
2016-03-21 11:49:16 -07:00
5faa71e1e0
Add API docs for all Collection methods
...
Resolves #298
2016-03-20 11:57:40 -07:00
92461f2598
Update API docs with encryptionKey
2016-03-17 15:14:56 -07:00
aa5529e059
Update List splice doc to be more clear about count
2016-03-17 15:12:18 -07:00
933326c410
Add List splice method to API docs
...
It was mysteriously missing!
2016-03-17 14:49:12 -07:00
27073a9e66
Properly configure ESLint for syntax checking
...
Added a test case to run on CI as well.
2016-03-16 13:01:38 -07:00
91960152df
Capitalize Realm in API docs
2016-03-07 12:23:04 -08:00
52f296c3ac
Update API docs with info about constructors
2016-03-04 14:13:28 -08:00
89ce54799f
Merge pull request #271 from realm/sk-docs-update
...
Update API docs with sorted/filtered changes
2016-02-21 19:03:49 -08:00
c1e5cb03cf
Update API docs with sorted/filtered changes
2016-02-21 17:51:58 -08:00
5e9333b699
no message
2016-02-18 15:30:44 -08:00
ea2c119f4d
Remove some API doc qualifiers
2016-02-12 16:57:13 -08:00
b63dfd1c04
API documentation
...
This includes the initial draft of API docs that are generated by JSDoc using a template that was greatly improved to best handle this content.
2016-02-12 16:57:13 -08:00
Ari Lazier
Kristian Dupont
Radu Tutueanu
Yavor Georgiev
Radu Tutueanu
Søren Vind
Scott Kyle
Karson Miller