ezp-26872: reveiw fix

ezsystems · Feb 9, 2017 · 5c6915c · 5c6915c
1 parent e0698c7
commit 5c6915c
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/Resources/public/js/views/services/ez-universaldiscoveryviewservice.js b/Resources/public/js/views/services/ez-universaldiscoveryviewservice.js
@@ -22,6 +22,8 @@ YUI.add('ez-universaldiscoveryviewservice', function (Y) {
      */
     Y.eZ.UniversalDiscoveryViewService = Y.Base.create('universalDiscoveryViewService', Y.eZ.ViewService, [Y.eZ.SideViewService], {
         /**
+         * Loads the starting location of the UDW if there is a provided starting location id.
+         * Else starting location is set to false.
          *
          * @method _load
          * @protected
@@ -50,12 +52,13 @@ YUI.add('ez-universaldiscoveryviewservice', function (Y) {
         },
 
         /**
-         * `Get the path of the UDW starting Location.
+         * Loads the path of the UDW starting Location.
          *
          * @method _loadStartingLocationPath
          * @protected
          * @param {eZ.Location} startingLocation
-         * @param {Function} callback
+         * @param {Function} callback Executed after loading the path. Takes the location containing the path in parameter or false if loading error.
+         *
          */
         _loadStartingLocationPath: function (startingLocation, callback) {
             var options = {api: this.get('capi')};
@@ -95,12 +98,12 @@ YUI.add('ez-universaldiscoveryviewservice', function (Y) {
         ATTRS: {
 
             /**
-             * Holds the starting location where the UDW will .
+             * Holds the starting location where the UDW will start.
              * False if no starting location defined
              *
              * @attribute startingLocation
              * @default false
-             * @type {eZ.Location}
+             * @type {eZ.Location|False}
              */
             startingLocation: {
                 value: false,