Merge pull request angular-ui#5112 from nkovacic/expandable-docs

Added expandableRowScope ngDocs
michalgm · Feb 15, 2016 · 7274632 · 7274632
2 parents c61f680 + e10c5c9
commit 7274632
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/features/expandable/js/expandable.js b/src/features/expandable/js/expandable.js
@@ -416,6 +416,18 @@
               gridUtil.getTemplate($scope.grid.options.expandableRowTemplate).then(
                 function (template) {
                   if ($scope.grid.options.expandableRowScope) {
+                    /**
+                     *  @ngdoc object
+                     *  @name expandableRowScope
+                     *  @propertyOf  ui.grid.expandable.api:GridOptions
+                     *  @description  Variables of object expandableScope will be available in the scope of the expanded subgrid
+                     *  @example
+                     *  <pre>
+                     *    $scope.gridOptions = {
+                     *      expandableRowScope: expandableScope
+                     *    }
+                     *  </pre>
+                     */
                     var expandableRowScope = $scope.grid.options.expandableRowScope;
                     for (var property in expandableRowScope) {
                       if (expandableRowScope.hasOwnProperty(property)) {