docs(tree-base.js): Updating documentation for treeBase feature.

Author: Portugal, Marcelo

src/features/tree-base/js/tree-base.js

@@ -989,9 +989,6 @@
         }
 
         var grid = this;
-        var currentLevel = 0;
-        var currentState = uiGridTreeBaseConstants.EXPANDED;
-        var parents = [];
 
         grid.treeBase.tree = service.createTree( grid, renderableRows );
         service.updateRowHeaderWidth( grid );
@@ -1050,7 +1047,7 @@
        * @description Creates an array of rows based on the tree, exporting only
        * the visible nodes and leaves
        *
-       * @param {array} nodeList the list of nodes - can be grid.treeBase.tree, or can be node.children when
+       * @param {array} nodeList The list of nodes - can be grid.treeBase.tree, or can be node.children when
        * we're calling recursively
        * @returns {array} renderable rows
        */
@@ -1075,9 +1072,9 @@
        * @methodOf  ui.grid.treeBase.service:uiGridTreeBaseService
        * @description Creates a tree from the renderableRows
        *
-       * @param {Grid} grid the grid
-       * @param {array} renderableRows the rows we want to create a tree from
-       * @returns {object} the tree we've build
+       * @param {Grid} grid The grid
+       * @param {array} renderableRows The rows we want to create a tree from
+       * @returns {object} The tree we've build
        */
       createTree: function( grid, renderableRows ) {
         var currentLevel = -1;
@@ -1147,11 +1144,11 @@
        * @description Creates a tree node for this row.  If this row already has a treeNode
        * recorded against it, preserves the state, but otherwise overwrites the data.
        *
-       * @param {grid} grid the grid we're operating on
-       * @param {gridRow} row the row we want to set
-       * @param {array} parents an array of the parents this row should have
-       * @param {array} aggregationBase empty aggregation information
-       * @returns {undefined} updates the parents array, updates the row to have a treeNode, and updates the
+       * @param {grid} grid The grid we're operating on
+       * @param {gridRow} row The row we want to set
+       * @param {array} parents An array of the parents this row should have
+       * @param {array} aggregationBase Empty aggregation information
+       * @returns {undefined} Updates the parents array, updates the row to have a treeNode, and updates the
        * grid.treeBase.tree
        */
       addOrUseNode: function( grid, row, parents, aggregationBase ){
@@ -1185,8 +1182,8 @@
        * If any node in the hierarchy is collapsed, then return collapsed, otherwise return
        * expanded.
        *
-       * @param {array} parents an array of the parents this row should have
-       * @returns {string} the state we should be setting to any nodes we see
+       * @param {array} parents An array of the parents this row should have
+       * @returns {string} The state we should be setting to any nodes we see
        */
       setCurrentState: function( parents ){
         var currentState = uiGridTreeBaseConstants.EXPANDED;
@@ -1213,8 +1210,8 @@
        * We only sort tree nodes that are expanded - no point in wasting effort sorting collapsed
        * nodes
        *
-       * @param {Grid} grid the grid to get the aggregation information from
-       * @returns {array} the aggregation information
+       * @param {Grid} grid The grid to get the aggregation information from
+       * @returns {array} The aggregation information
        */
       sortTree: function( grid ){
         grid.columns.forEach( function( column ) {
@@ -1303,8 +1300,8 @@
        * @description Build the object which is stored on the column for holding meta-data about the aggregation.
        * This method should only be called with columns which have an aggregation.
        *
-       * @param {Column} the column which this object relates to
-       * @returns {object} {col: Column object, label: string, type: string (optional)}
+       * @param {GridColumn} column The column which this object relates to
+       * @returns {object} {col: GridColumn object, label: string, type: string (optional)}
        */
       buildAggregationObject: function( column ){
         var newAggregation = { col: column };
@@ -1479,8 +1476,8 @@
        * @methodOf  ui.grid.treeBase.service:uiGridTreeBaseService
        * @description Helper function used to finalize aggregation nodes and footer cells
        *
-       * @param {gridRow} row the parent we're finalising
-       * @param {aggregation} the aggregation object manipulated by the aggregationFn
+       * @param {gridRow} row The parent we're finalising
+       * @param {aggregation} aggregation The aggregation object manipulated by the aggregationFn
        */
       finaliseAggregation: function(row, aggregation){
         if ( aggregation.col.treeAggregationUpdateEntity && typeof(row) !== 'undefined' && typeof(row.entity[ '$$' + aggregation.col.uid ]) !== 'undefined' ){
@@ -1544,8 +1541,8 @@
        * @description Uses the tree aggregation functions and finalizers to set the
        * column footer aggregations.
        *
-       * @param {rows} visible rows. not used, but accepted to match signature of GridColumn.aggregationType
-       * @param {GridColumn} column the column we are finalizing
+       * @param {rows} rows The visible rows. not used, but accepted to match signature of GridColumn.aggregationType
+       * @param {GridColumn} column The column we are finalizing
        */
       treeFooterAggregationType: function( rows, column ) {
         service.finaliseAggregation(undefined, column.treeFooterAggregation);