From 83cc0b65d5e5e6bcb41f4abaafb5828024c7fbb4 Mon Sep 17 00:00:00 2001 From: Shivam Dave Date: Tue, 23 Jun 2015 16:35:34 -0700 Subject: [PATCH] [Windowing] Comments Added comments to files. WTD-16. --- .../browse/src/services/UrlService.js | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/platform/commonUI/browse/src/services/UrlService.js b/platform/commonUI/browse/src/services/UrlService.js index 4fcf836d36..8bae239d1c 100644 --- a/platform/commonUI/browse/src/services/UrlService.js +++ b/platform/commonUI/browse/src/services/UrlService.js @@ -30,11 +30,15 @@ define( "use strict"; /** - * The navigation service maintains the application's current - * navigation state, and allows listening for changes thereto. - * @constructor + * The url service handles calls for url paths + * using domain objects. */ function UrlService($location) { + // Returns the url for the mode wanted + // and the domainObject passed in. A path + // is returned. The view is defaulted to + // the current location's (current object's) + // view set. function urlFor(mode, domainObject) { var context = domainObject && domainObject.getCapability('context'), @@ -48,9 +52,14 @@ define( } return { - + /** + * Returns the Url path for a specific domain object + * @param {value} value of the browse or edit mode + * for the path + * @param {DomainObject} value of the domain object + * to get the path of + */ urlFor: urlFor - }; }