Beautify the docs
This commit is contained in:
Peter 'Pita' Martischka
parent
f7b46f6e69
commit
c4325a050f
|
|
@ -9,6 +9,7 @@ https://github.com/Pita/etherpad-lite/blob/master/doc/easysync/easysync-notes.tx
|
|||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### createAttributePool ()
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### _slicerZipperFunc (attOp, csOp, opOut, pool)
|
||||
|
||||
* **attOp** *No description*
|
||||
|
|
@ -10,28 +11,33 @@
|
|||
* **opOut** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### appendATextToAssembler (atext, assem)
|
||||
|
||||
* **atext** *No description*
|
||||
* **assem** *No description*
|
||||
|
||||
- - -
|
||||
### applyToAText (cs, atext, pool)
|
||||
|
||||
* **cs** *No description*
|
||||
* **atext** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### applyToAttribution (cs, astr, pool)
|
||||
|
||||
* **cs** *No description*
|
||||
* **astr** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### applyToText (cs, str)
|
||||
|
||||
* **cs** *No description*
|
||||
* **str** *No description*
|
||||
|
||||
- - -
|
||||
### applyZip (in1, idx1, in2, idx2, func)
|
||||
|
||||
* **in1** *No description*
|
||||
|
|
@ -40,21 +46,25 @@
|
|||
* **idx2** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
- - -
|
||||
### attribsAttributeValue (attribs, key, pool)
|
||||
|
||||
* **attribs** *No description*
|
||||
* **key** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### attributeTester (attribPair, pool)
|
||||
|
||||
* **attribPair** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### builder (oldLen)
|
||||
|
||||
* **oldLen** *No description*
|
||||
|
||||
- - -
|
||||
### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
|
||||
|
||||
* **cs** *No description*
|
||||
|
|
@ -62,28 +72,34 @@
|
|||
* **endChar** *No description*
|
||||
* **insertionsAfter** *No description*
|
||||
|
||||
- - -
|
||||
### checkRep (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
- - -
|
||||
### clearOp (op)
|
||||
|
||||
* **op** *No description*
|
||||
|
||||
- - -
|
||||
### cloneAText (atext)
|
||||
|
||||
* **atext** *No description*
|
||||
|
||||
- - -
|
||||
### cloneOp (op)
|
||||
|
||||
* **op** *No description*
|
||||
|
||||
- - -
|
||||
### compose (cs1, cs2, pool)
|
||||
|
||||
* **cs1** *No description*
|
||||
* **cs2** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### composeAttributes (att1, att2, resultIsMutation, pool)
|
||||
|
||||
* **att1** *No description*
|
||||
|
|
@ -91,26 +107,31 @@
|
|||
* **resultIsMutation** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### copyAText (atext1, atext2)
|
||||
|
||||
* **atext1** *No description*
|
||||
* **atext2** *No description*
|
||||
|
||||
- - -
|
||||
### copyOp (op1, op2)
|
||||
|
||||
* **op1** *No description*
|
||||
* **op2** *No description*
|
||||
|
||||
- - -
|
||||
### eachAttribNumber (cs, func)
|
||||
|
||||
* **cs** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
- - -
|
||||
### filterAttribNumbers (cs, filter)
|
||||
|
||||
* **cs** *No description*
|
||||
* **filter** *No description*
|
||||
|
||||
- - -
|
||||
### follow (cs1, cs2, reverseInsertOrder, pool)
|
||||
|
||||
* **cs1** *No description*
|
||||
|
|
@ -118,16 +139,19 @@
|
|||
* **reverseInsertOrder** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### followAttributes (att1, att2, pool)
|
||||
|
||||
* **att1** *No description*
|
||||
* **att2** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### identity (N)
|
||||
|
||||
* **N** *No description*
|
||||
|
||||
- - -
|
||||
### inverse (cs, lines, alines, pool)
|
||||
|
||||
* **cs** *No description*
|
||||
|
|
@ -135,29 +159,35 @@
|
|||
* **alines** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### isIdentity (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
- - -
|
||||
### joinAttributionLines (theAlines)
|
||||
|
||||
* **theAlines** *No description*
|
||||
|
||||
- - -
|
||||
### makeAText (text, attribs)
|
||||
|
||||
* **text** *No description*
|
||||
* **attribs** *No description*
|
||||
|
||||
- - -
|
||||
### makeAttribsString (opcode, attribs, pool)
|
||||
|
||||
* **opcode** *No description*
|
||||
* **attribs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### makeAttribution (text)
|
||||
|
||||
* **text** *No description*
|
||||
|
||||
- - -
|
||||
### makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
|
||||
|
||||
* **oldFullText** *No description*
|
||||
|
|
@ -167,71 +197,86 @@
|
|||
* **optNewTextAPairs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### mapAttribNumbers (cs, func)
|
||||
|
||||
* **cs** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
- - -
|
||||
### mergingOpAssembler ()
|
||||
|
||||
|
||||
- - -
|
||||
### moveOpsToNewPool (cs, oldPool, newPool)
|
||||
|
||||
* **cs** *No description*
|
||||
* **oldPool** *No description*
|
||||
* **newPool** *No description*
|
||||
|
||||
- - -
|
||||
### mutateAttributionLines (cs, lines, pool)
|
||||
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### mutateTextLines (cs, lines)
|
||||
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
|
||||
- - -
|
||||
### newLen (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
- - -
|
||||
### newOp (optOpcode)
|
||||
|
||||
* **optOpcode** *No description*
|
||||
|
||||
- - -
|
||||
### numToString (num)
|
||||
|
||||
* **num** *No description*
|
||||
|
||||
- - -
|
||||
### oldLen (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
- - -
|
||||
### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
|
||||
|
||||
* **opsStr** *No description*
|
||||
* **optStartIndex** *No description*
|
||||
* **charBank** *No description*
|
||||
|
||||
- - -
|
||||
### opAssembler ()
|
||||
|
||||
|
||||
- - -
|
||||
### opAttributeValue (op, key, pool)
|
||||
|
||||
* **op** *No description*
|
||||
* **key** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### opIterator (opsStr, optStartIndex)
|
||||
|
||||
* **opsStr** *No description*
|
||||
* **optStartIndex** *No description*
|
||||
|
||||
- - -
|
||||
### opString (op)
|
||||
|
||||
* **op** *No description*
|
||||
|
||||
- - -
|
||||
### pack (oldLen, newLen, opsStr, bank)
|
||||
|
||||
* **oldLen** *No description*
|
||||
|
|
@ -239,65 +284,80 @@
|
|||
* **opsStr** *No description*
|
||||
* **bank** *No description*
|
||||
|
||||
- - -
|
||||
### parseNum (str)
|
||||
|
||||
* **str** *No description*
|
||||
|
||||
- - -
|
||||
### prepareForWire (cs, pool)
|
||||
|
||||
* **cs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
- - -
|
||||
### smartOpAssembler ()
|
||||
|
||||
|
||||
- - -
|
||||
### splitAttributionLines (attrOps, text)
|
||||
|
||||
* **attrOps** *No description*
|
||||
* **text** *No description*
|
||||
|
||||
- - -
|
||||
### splitTextLines (text)
|
||||
|
||||
* **text** *No description*
|
||||
|
||||
- - -
|
||||
### stringAssembler ()
|
||||
|
||||
|
||||
- - -
|
||||
### stringIterator (str)
|
||||
|
||||
* **str** *No description*
|
||||
|
||||
- - -
|
||||
### stringOp (str)
|
||||
|
||||
* **str** *No description*
|
||||
|
||||
- - -
|
||||
### subattribution (astr, start, optEnd)
|
||||
|
||||
* **astr** *No description*
|
||||
* **start** *No description*
|
||||
* **optEnd** *No description*
|
||||
|
||||
- - -
|
||||
### textLinesMutator (lines)
|
||||
|
||||
* **lines** *No description*
|
||||
|
||||
- - -
|
||||
### toBaseTen (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
- - -
|
||||
### toSplices (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
- - -
|
||||
### unpack (cs)
|
||||
|
||||
* **cs** *No description*
|
||||
|
||||
##Variables
|
||||
|
||||
- - -
|
||||
### assert
|
||||
|
||||
|
||||
- - -
|
||||
### error
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,22 +5,26 @@ The MessageHandler handles all Messages that comes from Socket.IO and controls t
|
|||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### handleConnect (client)
|
||||
Handles the connection of a new user
|
||||
|
||||
* **client** the new client
|
||||
|
||||
- - -
|
||||
### handleDisconnect (client)
|
||||
Handles the disconnection of a user
|
||||
|
||||
* **client** the client that leaves
|
||||
|
||||
- - -
|
||||
### handleMessage (client, message)
|
||||
Handles a message from a user
|
||||
|
||||
* **client** the client that send this message
|
||||
* **message** the message from the client
|
||||
|
||||
- - -
|
||||
### setSocketIO (socket_io)
|
||||
A associative array that translates a session to a pad
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ 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
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ The Pad Manager is a Factory for pad Objects
|
|||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### getPad (id, callback)
|
||||
A Array with all known Pads
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ provided by the settings module
|
|||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### init (callback)
|
||||
Initalizes the database with the settings provided by the settings module
|
||||
|
||||
|
|
@ -13,6 +14,7 @@ Initalizes the database with the settings provided by the settings module
|
|||
|
||||
##Variables
|
||||
|
||||
- - -
|
||||
### db
|
||||
The UeberDB Object that provides the database functions
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ minification && compression of Javascript and CSS.
|
|||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### padJS (req, res)
|
||||
Answers a http request for the pad javascript
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ to MessageHandler and minfied requests are passed to minified.
|
|||
|
||||
##Variables
|
||||
|
||||
- - -
|
||||
### maxAge
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,21 +6,27 @@ this information to the other modules
|
|||
|
||||
##Variables
|
||||
|
||||
- - -
|
||||
### dbSettings
|
||||
This setting is passed with dbType to ueberDB to set up the database
|
||||
|
||||
- - -
|
||||
### dbType
|
||||
|
||||
|
||||
- - -
|
||||
### defaultPadText
|
||||
The default Text of a new pad
|
||||
|
||||
- - -
|
||||
### logHTTP
|
||||
A flag that shows if http requests should be loged to stdout
|
||||
|
||||
- - -
|
||||
### minify
|
||||
A flag that shows if minification is enabled or not
|
||||
|
||||
- - -
|
||||
### port
|
||||
The Port ep-lite should listen to
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue