From 5c6915cbf20a6aa5a291299a245769119001cb42 Mon Sep 17 00:00:00 2001 From: stephaneDiot Date: Thu, 9 Feb 2017 15:42:09 +0100 Subject: [PATCH] ezp-26872: reveiw fix --- .../services/ez-universaldiscoveryviewservice.js | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/Resources/public/js/views/services/ez-universaldiscoveryviewservice.js b/Resources/public/js/views/services/ez-universaldiscoveryviewservice.js index 1e03cd83b..b2ff75ec5 100644 --- 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,