mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-24 17:36:14 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 33

Beautify the docs

Browse source
This commit is contained in:
Peter 'Pita' Martischka 2011-05-30 16:05:42 +01:00
parent f7b46f6e69
commit c4325a050f
10 changed files with 82 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/jsdoc/AuthorManager.md
View file

@ -5,6 +5,7 @@ The AuthorManager controlls all information about the Pad authors
## Functions
- - -
### getAuthor4Token (token, callback)
Returns the Author Id for a token. If the token is unkown,
it creates a author for the token
@ -13,18 +14,21 @@ it creates a author for 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
@ -32,6 +36,7 @@ Sets the color Id of the author
* **colorId** *No description*
* **callback** *(Function)* (optional)
- - -
### setAuthorName (author, name, callback)
Sets the name of the author