Continue documenting Ace API

lib/ace/split.js

@@ -47,20 +47,20 @@ var Editor = require("./editor").Editor;
 var Renderer = require("./virtual_renderer").VirtualRenderer;
 var EditSession = require("./edit_session").EditSession;
 
-/**
+/** internal
  * class Split
  *
- * TODO
+ *
  *
  **/
 
-/**
+/** internal
  * new Split(container, theme, splits)
- * - container (Document): The document to associate with the anchor
- * - theme (Number): The starting row position
- * - splits (Number): The starting column position
+ * - container (Document): The document to associate with the split
+ * - theme (String): The name of the initial theme
+ * - splits (Number): The number of initial splits
+ *
  *
- * TODO
  *
  **/
 
@@ -104,11 +104,11 @@ var Split = function(container, theme, splits) {
         return editor;
     };
 
-    /**
+    /** internal
      * Split.setSplits(splits) -> Void
      * - splits (Number): The new number of splits
      *
-     * TODO
+     * 
      *
      **/
     this.setSplits = function(splits) {
@@ -193,7 +193,7 @@ var Split = function(container, theme, splits) {
 
     /** related to: Editor.setTheme
      * Split.setTheme(theme) -> Void
-     * - theme (String):
+     * - theme (String): The name of the theme to set
      * 
      * Sets a theme for each of the available editors.
      **/
@@ -203,11 +203,11 @@ var Split = function(container, theme, splits) {
         });
     };
 
-    /** 
+    /** internal
      * Split.setKeyboardHandler(keybinding) -> Void
      * - keybinding (String):
      * 
-     * TODO
+     *
      **/
     this.setKeyboardHandler = function(keybinding) {
         this.$editors.forEach(function(editor) {
@@ -215,12 +215,12 @@ var Split = function(container, theme, splits) {
         });
     };
 
-    /** 
+    /** internal
      * Split.forEach(callback, scope) -> Void
      * - callback (Function): A callback function to execute
-     * - scope (String): TODO
+     * - scope (String): 
      * 
-     * Executes `callback` on all of the available editors. TODO
+     * Executes `callback` on all of the available editors. 
      *
      **/
     this.forEach = function(callback, scope) {
@@ -303,21 +303,21 @@ var Split = function(container, theme, splits) {
         return session;
     };
 
-   /** 
+   /** internal
      * Split.getOriantation() -> Number
      * 
-     * Returns the orientation. TODO
+     * Returns the orientation.
      *
      **/
     this.getOriantation = function() {
         return this.$oriantation;
     };
 
-   /** 
+   /** internal
      * Split.setOriantation(oriantation) -> Void
      * - oriantation (Number):
      *
-     * Sets the orientation. TODO
+     * Sets the orientation.
      *
      **/
     this.setOriantation = function(oriantation) {
@@ -328,10 +328,10 @@ var Split = function(container, theme, splits) {
         this.resize();
     };
 
-   /** 
+   /**  internal
      * Split.resize() -> Void
      *
-     *  TODO
+     *
      *
      **/
     this.resize = function() {
@@ -364,10 +364,10 @@ var Split = function(container, theme, splits) {
 
 }).call(Split.prototype);
 
-   /** 
+   /**  internal
      * Split.UndoManagerProxy() -> Void
      *
-     *  TODO
+     *  
      *
      **/
 function UndoManagerProxy(undoManager, session) {