From 61022be6e422e3608bb15cb230f862e0417239e8 Mon Sep 17 00:00:00 2001
From: Gedion <gwy321@gmail.com>
Date: Mon, 1 Oct 2012 19:14:27 -0500
Subject: [PATCH] added comments to ace exposed methods

---
 doc/api/editorInfo.md        | 22 +++++++++++++++++-----
 doc/api/hooks_client-side.md |  4 ++--
 2 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/doc/api/editorInfo.md b/doc/api/editorInfo.md
index a212ff085..6aec326e2 100644
--- a/doc/api/editorInfo.md
+++ b/doc/api/editorInfo.md
@@ -45,14 +45,26 @@ Returns the `rep` object.
 ## editorInfo.ace_doInsertUnorderedList(?)
 ## editorInfo.ace_doInsertOrderedList(?)
 ## editorInfo.ace_performDocumentApplyAttributesToRange()
+
 ## editorInfo.ace_getAuthorInfos()
-## editorInfo.ace_performDocumentReplaceRange(?)
-## editorInfo.ace_performDocumentReplaceCharRange(?)
-## editorInfo.ace_renumberList(?)
+Returns an info object about the author. Object key = author_id and info includes athour's bg color value.
+Use to define your own authorship.
+## editorInfo.ace_performDocumentReplaceRange(start, end, newText)
+This function replaces a range (from [x1,y1] to [x2,y2]) with `newText`.
+## editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)
+This function replaces a range (from y1 to y2) with `newText`.
+## editorInfo.ace_renumberList(lineNum)
+If you delete a line, calling this method will fix the line numbering.
 ## editorInfo.ace_doReturnKey()
-## editorInfo.ace_isBlockElement(?)
-## editorInfo.ace_getLineListType(?)
+Forces a return key at the current carret position.
+## editorInfo.ace_isBlockElement(element)
+Returns true if your passed elment is registered as a block element
+## editorInfo.ace_getLineListType(lineNum)
+Returns the line's html list type.
 ## editorInfo.ace_caretLine()
+Returns X position of the caret.
 ## editorInfo.ace_caretColumn()
+Returns Y position of the caret.
 ## editorInfo.ace_caretDocChar()
+Returns the Y offset starting from [x=0,y=0]
 ## editorInfo.ace_isWordChar(?)
diff --git a/doc/api/hooks_client-side.md b/doc/api/hooks_client-side.md
index 707800f5e..55d1da000 100644
--- a/doc/api/hooks_client-side.md
+++ b/doc/api/hooks_client-side.md
@@ -239,6 +239,6 @@ Things in context:
 3. class - line class
 
 This hook is provided to allow whether a given line should be deliniated with multiple authors.
-Multiple authors in one line cause the creation of magic span lines. This might not be suit you and
+Multiple authors in one line cause the creation of magic span lines. This might not suit you and
 now you can disable it and handle your own deliniation.
-The return value should be either true(disable ) or false.
+The return value should be either true(disable) or false.