mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-25 09:56:15 -04:00
Documentation
This commit is contained in:
Peter 'Pita' Martischka
parent
88297a99ef
commit
f7b46f6e69
22 changed files with 368 additions and 447 deletions
|
|
@ -1,328 +1,303 @@
|
|||
#Changeset
|
||||
# Changeset
|
||||
`require("./Changeset");`
|
||||
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
## Functions
|
||||
|
||||
##Functions
|
||||
### _slicerZipperFunc (attOp, csOp, opOut, pool)
|
||||
|
||||
###_slicerZipperFunc (attOp, csOp, opOut, pool)
|
||||
* **attOp** *No description*
|
||||
* **csOp** *No description*
|
||||
* **opOut** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **attOp**
|
||||
* **csOp**
|
||||
* **opOut**
|
||||
* **pool**
|
||||
### appendATextToAssembler (atext, assem)
|
||||
|
||||
###appendATextToAssembler (atext, assem)
|
||||
* **atext** *No description*
|
||||
* **assem** *No description*
|
||||
|
||||
* **atext**
|
||||
* **assem**
|
||||
### applyToAText (cs, atext, pool)
|
||||
|
||||
###applyToAText (cs, atext, pool)
|
||||
* **cs** *No description*
|
||||
* **atext** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **atext**
|
||||
* **pool**
|
||||
### applyToAttribution (cs, astr, pool)
|
||||
|
||||
###applyToAttribution (cs, astr, pool)
|
||||
* **cs** *No description*
|
||||
* **astr** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **astr**
|
||||
* **pool**
|
||||
### applyToText (cs, str)
|
||||
|
||||
###applyToText (cs, str)
|
||||
* **cs** *No description*
|
||||
* **str** *No description*
|
||||
|
||||
* **cs**
|
||||
* **str**
|
||||
### applyZip (in1, idx1, in2, idx2, func)
|
||||
|
||||
###applyZip (in1, idx1, in2, idx2, func)
|
||||
* **in1** *No description*
|
||||
* **idx1** *No description*
|
||||
* **in2** *No description*
|
||||
* **idx2** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
* **in1**
|
||||
* **idx1**
|
||||
* **in2**
|
||||
* **idx2**
|
||||
* **func**
|
||||
### attribsAttributeValue (attribs, key, pool)
|
||||
|
||||
###attribsAttributeValue (attribs, key, pool)
|
||||
* **attribs** *No description*
|
||||
* **key** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **attribs**
|
||||
* **key**
|
||||
* **pool**
|
||||
### attributeTester (attribPair, pool)
|
||||
|
||||
###attributeTester (attribPair, pool)
|
||||
* **attribPair** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **attribPair**
|
||||
* **pool**
|
||||
### builder (oldLen)
|
||||
|
||||
###builder (oldLen)
|
||||
* **oldLen** *No description*
|
||||
|
||||
* **oldLen**
|
||||
### characterRangeFollow (cs, startChar, endChar, insertionsAfter)
|
||||
|
||||
###characterRangeFollow (cs, startChar, endChar, insertionsAfter)
|
||||
* **cs** *No description*
|
||||
* **startChar** *No description*
|
||||
* **endChar** *No description*
|
||||
* **insertionsAfter** *No description*
|
||||
|
||||
* **cs**
|
||||
* **startChar**
|
||||
* **endChar**
|
||||
* **insertionsAfter**
|
||||
### checkRep (cs)
|
||||
|
||||
###checkRep (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### clearOp (op)
|
||||
|
||||
###clearOp (op)
|
||||
* **op** *No description*
|
||||
|
||||
* **op**
|
||||
### cloneAText (atext)
|
||||
|
||||
###cloneAText (atext)
|
||||
* **atext** *No description*
|
||||
|
||||
* **atext**
|
||||
### cloneOp (op)
|
||||
|
||||
###cloneOp (op)
|
||||
* **op** *No description*
|
||||
|
||||
* **op**
|
||||
### compose (cs1, cs2, pool)
|
||||
|
||||
###compose (cs1, cs2, pool)
|
||||
* **cs1** *No description*
|
||||
* **cs2** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs1**
|
||||
* **cs2**
|
||||
* **pool**
|
||||
### composeAttributes (att1, att2, resultIsMutation, pool)
|
||||
|
||||
###composeAttributes (att1, att2, resultIsMutation, pool)
|
||||
* **att1** *No description*
|
||||
* **att2** *No description*
|
||||
* **resultIsMutation** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **att1**
|
||||
* **att2**
|
||||
* **resultIsMutation**
|
||||
* **pool**
|
||||
### copyAText (atext1, atext2)
|
||||
|
||||
###copyAText (atext1, atext2)
|
||||
* **atext1** *No description*
|
||||
* **atext2** *No description*
|
||||
|
||||
* **atext1**
|
||||
* **atext2**
|
||||
### copyOp (op1, op2)
|
||||
|
||||
###copyOp (op1, op2)
|
||||
* **op1** *No description*
|
||||
* **op2** *No description*
|
||||
|
||||
* **op1**
|
||||
* **op2**
|
||||
### eachAttribNumber (cs, func)
|
||||
|
||||
###eachAttribNumber (cs, func)
|
||||
* **cs** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
* **cs**
|
||||
* **func**
|
||||
### filterAttribNumbers (cs, filter)
|
||||
|
||||
###filterAttribNumbers (cs, filter)
|
||||
* **cs** *No description*
|
||||
* **filter** *No description*
|
||||
|
||||
* **cs**
|
||||
* **filter**
|
||||
### follow (cs1, cs2, reverseInsertOrder, pool)
|
||||
|
||||
###follow (cs1, cs2, reverseInsertOrder, pool)
|
||||
* **cs1** *No description*
|
||||
* **cs2** *No description*
|
||||
* **reverseInsertOrder** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs1**
|
||||
* **cs2**
|
||||
* **reverseInsertOrder**
|
||||
* **pool**
|
||||
### followAttributes (att1, att2, pool)
|
||||
|
||||
###followAttributes (att1, att2, pool)
|
||||
* **att1** *No description*
|
||||
* **att2** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **att1**
|
||||
* **att2**
|
||||
* **pool**
|
||||
### identity (N)
|
||||
|
||||
###identity (N)
|
||||
* **N** *No description*
|
||||
|
||||
* **N**
|
||||
### inverse (cs, lines, alines, pool)
|
||||
|
||||
###inverse (cs, lines, alines, pool)
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
* **alines** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **lines**
|
||||
* **alines**
|
||||
* **pool**
|
||||
### isIdentity (cs)
|
||||
|
||||
###isIdentity (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### joinAttributionLines (theAlines)
|
||||
|
||||
###joinAttributionLines (theAlines)
|
||||
* **theAlines** *No description*
|
||||
|
||||
* **theAlines**
|
||||
### makeAText (text, attribs)
|
||||
|
||||
###makeAText (text, attribs)
|
||||
* **text** *No description*
|
||||
* **attribs** *No description*
|
||||
|
||||
* **text**
|
||||
* **attribs**
|
||||
### makeAttribsString (opcode, attribs, pool)
|
||||
|
||||
###makeAttribsString (opcode, attribs, pool)
|
||||
* **opcode** *No description*
|
||||
* **attribs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **opcode**
|
||||
* **attribs**
|
||||
* **pool**
|
||||
### makeAttribution (text)
|
||||
|
||||
###makeAttribution (text)
|
||||
* **text** *No description*
|
||||
|
||||
* **text**
|
||||
### makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
|
||||
|
||||
###makeSplice (oldFullText, spliceStart, numRemoved, newText, optNewTextAPairs, pool)
|
||||
* **oldFullText** *No description*
|
||||
* **spliceStart** *No description*
|
||||
* **numRemoved** *No description*
|
||||
* **newText** *No description*
|
||||
* **optNewTextAPairs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **oldFullText**
|
||||
* **spliceStart**
|
||||
* **numRemoved**
|
||||
* **newText**
|
||||
* **optNewTextAPairs**
|
||||
* **pool**
|
||||
### mapAttribNumbers (cs, func)
|
||||
|
||||
###mapAttribNumbers (cs, func)
|
||||
* **cs** *No description*
|
||||
* **func** *No description*
|
||||
|
||||
* **cs**
|
||||
* **func**
|
||||
### mergingOpAssembler ()
|
||||
|
||||
###mergingOpAssembler ()
|
||||
|
||||
* ****
|
||||
### moveOpsToNewPool (cs, oldPool, newPool)
|
||||
|
||||
###moveOpsToNewPool (cs, oldPool, newPool)
|
||||
* **cs** *No description*
|
||||
* **oldPool** *No description*
|
||||
* **newPool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **oldPool**
|
||||
* **newPool**
|
||||
### mutateAttributionLines (cs, lines, pool)
|
||||
|
||||
###mutateAttributionLines (cs, lines, pool)
|
||||
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS-IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **lines**
|
||||
* **pool**
|
||||
### mutateTextLines (cs, lines)
|
||||
|
||||
###mutateTextLines (cs, lines)
|
||||
* **cs** *No description*
|
||||
* **lines** *No description*
|
||||
|
||||
* **cs**
|
||||
* **lines**
|
||||
### newLen (cs)
|
||||
|
||||
###newLen (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### newOp (optOpcode)
|
||||
|
||||
###newOp (optOpcode)
|
||||
* **optOpcode** *No description*
|
||||
|
||||
* **optOpcode**
|
||||
### numToString (num)
|
||||
|
||||
###numToString (num)
|
||||
* **num** *No description*
|
||||
|
||||
* **num**
|
||||
### oldLen (cs)
|
||||
|
||||
###oldLen (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
|
||||
|
||||
###oneInsertedLineAtATimeOpIterator (opsStr, optStartIndex, charBank)
|
||||
* **opsStr** *No description*
|
||||
* **optStartIndex** *No description*
|
||||
* **charBank** *No description*
|
||||
|
||||
* **opsStr**
|
||||
* **optStartIndex**
|
||||
* **charBank**
|
||||
### opAssembler ()
|
||||
|
||||
###opAssembler ()
|
||||
|
||||
* ****
|
||||
### opAttributeValue (op, key, pool)
|
||||
|
||||
###opAttributeValue (op, key, pool)
|
||||
* **op** *No description*
|
||||
* **key** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **op**
|
||||
* **key**
|
||||
* **pool**
|
||||
### opIterator (opsStr, optStartIndex)
|
||||
|
||||
###opIterator (opsStr, optStartIndex)
|
||||
* **opsStr** *No description*
|
||||
* **optStartIndex** *No description*
|
||||
|
||||
* **opsStr**
|
||||
* **optStartIndex**
|
||||
### opString (op)
|
||||
|
||||
###opString (op)
|
||||
* **op** *No description*
|
||||
|
||||
* **op**
|
||||
### pack (oldLen, newLen, opsStr, bank)
|
||||
|
||||
###pack (oldLen, newLen, opsStr, bank)
|
||||
* **oldLen** *No description*
|
||||
* **newLen** *No description*
|
||||
* **opsStr** *No description*
|
||||
* **bank** *No description*
|
||||
|
||||
* **oldLen**
|
||||
* **newLen**
|
||||
* **opsStr**
|
||||
* **bank**
|
||||
### parseNum (str)
|
||||
|
||||
###parseNum (str)
|
||||
* **str** *No description*
|
||||
|
||||
* **str**
|
||||
### prepareForWire (cs, pool)
|
||||
|
||||
###prepareForWire (cs, pool)
|
||||
* **cs** *No description*
|
||||
* **pool** *No description*
|
||||
|
||||
* **cs**
|
||||
* **pool**
|
||||
### smartOpAssembler ()
|
||||
|
||||
###smartOpAssembler ()
|
||||
|
||||
* ****
|
||||
### splitAttributionLines (attrOps, text)
|
||||
|
||||
###splitAttributionLines (attrOps, text)
|
||||
* **attrOps** *No description*
|
||||
* **text** *No description*
|
||||
|
||||
* **attrOps**
|
||||
* **text**
|
||||
### splitTextLines (text)
|
||||
|
||||
###splitTextLines (text)
|
||||
* **text** *No description*
|
||||
|
||||
* **text**
|
||||
### stringAssembler ()
|
||||
|
||||
###stringAssembler ()
|
||||
|
||||
* ****
|
||||
### stringIterator (str)
|
||||
|
||||
###stringIterator (str)
|
||||
* **str** *No description*
|
||||
|
||||
* **str**
|
||||
### stringOp (str)
|
||||
|
||||
###stringOp (str)
|
||||
* **str** *No description*
|
||||
|
||||
* **str**
|
||||
### subattribution (astr, start, optEnd)
|
||||
|
||||
###subattribution (astr, start, optEnd)
|
||||
* **astr** *No description*
|
||||
* **start** *No description*
|
||||
* **optEnd** *No description*
|
||||
|
||||
* **astr**
|
||||
* **start**
|
||||
* **optEnd**
|
||||
### textLinesMutator (lines)
|
||||
|
||||
###textLinesMutator (lines)
|
||||
* **lines** *No description*
|
||||
|
||||
* **lines**
|
||||
### toBaseTen (cs)
|
||||
|
||||
###toBaseTen (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### toSplices (cs)
|
||||
|
||||
###toSplices (cs)
|
||||
* **cs** *No description*
|
||||
|
||||
* **cs**
|
||||
### unpack (cs)
|
||||
|
||||
###unpack (cs)
|
||||
|
||||
* **cs**
|
||||
* **cs** *No description*
|
||||
|
||||
##Variables
|
||||
|
||||
###assert
|
||||
### assert
|
||||
|
||||
|
||||
###error
|
||||
### error
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue