mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-24 17:36:14 -04:00
updated documentation
This commit is contained in:
parent
f1d06c55b4
commit
0772f6bb4e
16 changed files with 188 additions and 20 deletions
53
doc/jsdoc/db/AuthorManager.md
Normal file
53
doc/jsdoc/db/AuthorManager.md
Normal file
|
@ -0,0 +1,53 @@
|
|||
# db/AuthorMana
|
||||
`require("./db/AuthorManager");`
|
||||
|
||||
The AuthorManager controlls all information about the Pad authors
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### getAuthor (author, callback)
|
||||
Internal function that creates the database entry for an author
|
||||
|
||||
* **author** *(String)* The id of the author
|
||||
* **callback** *(Function)* callback(err, authorObj)
|
||||
|
||||
- - -
|
||||
### getAuthor4Token (token, callback)
|
||||
Returns the Author Id for a token. If the token is unkown,
|
||||
it creates a author for the token
|
||||
|
||||
* **token** *(String)* The token
|
||||
* **callback** *(Function)* callback (err, author)
|
||||
The callback function that is called when the result is here
|
||||
|
||||
- - -
|
||||
### getAuthorColorId (author, callback)
|
||||
Returns the color Id of the author
|
||||
|
||||
* **author** *(String)* The id of the author
|
||||
* **callback** *(Function)* callback(err, colorId)
|
||||
|
||||
- - -
|
||||
### getAuthorName (author, callback)
|
||||
Returns the name of the author
|
||||
|
||||
* **author** *(String)* The id of the author
|
||||
* **callback** *(Function)* callback(err, name)
|
||||
|
||||
- - -
|
||||
### setAuthorColorId (author, colorId, callback)
|
||||
Sets the color Id of the author
|
||||
|
||||
* **author** *(String)* The id of the author
|
||||
* **colorId** *No description*
|
||||
* **callback** *(Function)* (optional)
|
||||
|
||||
- - -
|
||||
### setAuthorName (author, name, callback)
|
||||
Sets the name of the author
|
||||
|
||||
* **author** *(String)* The id of the author
|
||||
* **name** *No description*
|
||||
* **callback** *(Function)* (optional)
|
||||
|
20
doc/jsdoc/db/DB.md
Normal file
20
doc/jsdoc/db/DB.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
# db
|
||||
`require("./db/DB");`
|
||||
|
||||
The DB Module provides a database initalized with the settings
|
||||
provided by the settings module
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### init (callback)
|
||||
Initalizes the database with the settings provided by the settings module
|
||||
|
||||
* **callback** *(Function)* *No description*
|
||||
|
||||
##Variables
|
||||
|
||||
- - -
|
||||
### db
|
||||
The UeberDB Object that provides the database functions
|
||||
|
13
doc/jsdoc/db/Pad.md
Normal file
13
doc/jsdoc/db/Pad.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
# db/
|
||||
`require("./db/Pad");`
|
||||
|
||||
The pad object, defined with joose
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### cleanText (txt)
|
||||
Copied from the Etherpad source code. It converts Windows line breaks to Unix line breaks and convert Tabs to spaces
|
||||
|
||||
* **txt** *No description*
|
||||
|
14
doc/jsdoc/db/PadManager.md
Normal file
14
doc/jsdoc/db/PadManager.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
# db/PadMana
|
||||
`require("./db/PadManager");`
|
||||
|
||||
The Pad Manager is a Factory for pad Objects
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### getPad (id, callback)
|
||||
A Array with all known Pads
|
||||
|
||||
* **id** A String with the id of the pad
|
||||
* **callback** *(Function)* *No description*
|
||||
|
21
doc/jsdoc/db/ReadOnlyManager.md
Normal file
21
doc/jsdoc/db/ReadOnlyManager.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
# db/ReadOnlyMana
|
||||
`require("./db/ReadOnlyManager");`
|
||||
|
||||
The ReadOnlyManager manages the database and rendering releated to read only pads
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### getPadId (readOnlyId, callback)
|
||||
returns a the padId for a read only id
|
||||
|
||||
* **readOnlyId** *(String)* read only id
|
||||
* **callback** *No description*
|
||||
|
||||
- - -
|
||||
### getReadOnlyId (padId, callback)
|
||||
returns a read only id for a pad
|
||||
|
||||
* **padId** *(String)* the id of the pad
|
||||
* **callback** *No description*
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue