From ac86535cdf0e6f6282385e246725334a826d2acc Mon Sep 17 00:00:00 2001
From: Constantin Jucovschi <jucovschi@gmail.com>
Date: Sun, 26 Feb 2012 11:34:06 +0000
Subject: [PATCH] more docs

---
 static/js/Changeset.js | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/static/js/Changeset.js b/static/js/Changeset.js
index e6f92b20..ee99e76c 100644
--- a/static/js/Changeset.js
+++ b/static/js/Changeset.js
@@ -182,12 +182,21 @@ exports.opIterator = function (opsStr, optStartIndex) {
   };
 };
 
+/**
+ * Cleans an Op object
+ * @param {Op} object to be cleared
+ */
 exports.clearOp = function (op) {
   op.opcode = '';
   op.chars = 0;
   op.lines = 0;
   op.attribs = '';
 };
+
+/**
+ * Creates a new Op object
+ * @param optOpcode the type operation of the Op object
+ */
 exports.newOp = function (optOpcode) {
   return {
     opcode: (optOpcode || ''),
@@ -196,6 +205,11 @@ exports.newOp = function (optOpcode) {
     attribs: ''
   };
 };
+
+/**
+ * Clones an Op
+ * @param op Op to be cloned
+ */
 exports.cloneOp = function (op) {
   return {
     opcode: op.opcode,
@@ -204,12 +218,22 @@ exports.cloneOp = function (op) {
     attribs: op.attribs
   };
 };
+
+/**
+ * Copies op1 to op2
+ * @param op1 src Op
+ * @param op2 dest Op
+ */
 exports.copyOp = function (op1, op2) {
   op2.opcode = op1.opcode;
   op2.chars = op1.chars;
   op2.lines = op1.lines;
   op2.attribs = op1.attribs;
 };
+
+/**
+ * Writes the Op in a string the way that changesets need it
+ */
 exports.opString = function (op) {
   // just for debugging
   if (!op.opcode) return 'null';
@@ -217,11 +241,19 @@ exports.opString = function (op) {
   assem.append(op);
   return assem.toString();
 };
+
+/**
+ * Used just for debugging
+ */
 exports.stringOp = function (str) {
   // just for debugging
   return exports.opIterator(str).next();
 };
 
+/**
+ * Used to check if a Changeset if valid
+ * @param cs {Changeset} Changeset to be checked
+ */
 exports.checkRep = function (cs) {
   // doesn't check things that require access to attrib pool (e.g. attribute order)
   // or original string (e.g. newline positions)
@@ -271,6 +303,10 @@ exports.checkRep = function (cs) {
   return cs;
 }
 
+
+/**
+ * ==================== Changeset Functions =======================
+ */
 exports.smartOpAssembler = function () {
   // Like opAssembler but able to produce conforming exportss
   // from slightly looser input, at the cost of speed.