Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typescript friendly types in comments #4403

Merged
merged 2 commits into from
Nov 23, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contribs/gmf/apps/desktop/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractDesktopController}
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/apps/desktop_alt/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @param {ngeo.misc.File} ngeoFile The file service.
* @param {gettext} gettext The gettext service
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/apps/iframe_api/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractAPIController}
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/apps/mobile/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractMobileController}
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/apps/mobile_alt/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractMobileController}
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/apps/oeedit/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @param {angular.ITimeoutService} $timeout Angular timeout service.
* @constructor
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/apps/oeview/Controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if (!window.requestAnimationFrame) {
}

/**
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractDesktopController}
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/examples/datepicker.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale

/**
* @constructor
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {!ngeo.misc.WMSTime} ngeoWMSTime wmstime service.
* @ngInject
*/
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/drawfeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale


/**
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {ngeo.misc.FeatureHelper} ngeoFeatureHelper Gmf feature helper service.
* @param {ol.Collection.<ol.Feature>} ngeoFeatures Collection of features.
* @param {ngeo.misc.ToolActivateMgr} ngeoToolActivateMgr Ngeo ToolActivate manager
Expand All @@ -56,7 +56,7 @@ exports.MainController = function($scope, ngeoFeatureHelper, ngeoFeatures,
ngeoToolActivateMgr, ngeoFeatureOverlayMgr) {

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/editfeature.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale


/**
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {gmf.editing.EditFeature} gmfEditFeature Gmf edit feature service.
* @param {gmfx.User} gmfUser User.
* @constructor
Expand All @@ -51,7 +51,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale
exports.MainController = function($scope, gmfEditFeature, gmfUser) {

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/editfeatureselector.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale


/**
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {gmf.theme.Themes} gmfThemes The gmf themes service.
* @param {gmf.layertree.TreeManager} gmfTreeManager gmf Tree Manager service.
* @param {gmfx.User} gmfUser User.
Expand All @@ -68,7 +68,7 @@ exports.MainController = function($scope, gmfThemes, gmfTreeManager, gmfUser,
ngeoFeatureHelper, ngeoToolActivateMgr) {

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/featurestyle.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale

/**
* @constructor
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {ngeo.misc.FeatureHelper} ngeoFeatureHelper Gmf feature helper service.
* @ngInject
*/
exports.MainController = function($scope, ngeoFeatureHelper) {

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/filterselector.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale
exports.MainController = class {

/**
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {gmf.datasource.Manager} gmfDataSourcesManager The gmf
* data sources manager service.
* @param {gmf.theme.Themes} gmfThemes The gmf themes service.
Expand All @@ -75,7 +75,7 @@ exports.MainController = class {
) {

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/importdatasource.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale
exports.MainController = class {

/**
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {gmf.datasource.Manager} gmfDataSourcesManager The gmf
* data sources manager service.
* @param {gmf.theme.Themes} gmfThemes The gmf themes service.
Expand All @@ -84,7 +84,7 @@ exports.MainController = class {
) {

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/examples/lidarprofile.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ exports.module.value('pytreeLidarprofileJsonUrl', 'https://sitn.ne.ch/pytree');


/**
* @param {angular.Scope} $scope Angular scope.
* @param {angular.IScope} $scope Angular scope.
* @constructor
* @ngInject
*/
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/examples/objecteditinghub.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale
/**
* @param {angular.IHttpService} $http Angular $http service.
* @param {angular.IQService} $q Angular $q service.
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {gmf.theme.Themes} gmfThemes The gmf themes service.
* @param {gmf.editing.XSDAttributes} gmfXSDAttributes The gmf XSDAttributes service.
* @constructor
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/examples/profile.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale


/**
* @param {angular.Scope} $scope Angular scope.
* @param {angular.IScope} $scope Angular scope.
* @param {ngeo.map.FeatureOverlayMgr} ngeoFeatureOverlayMgr Feature overlay
* manager.
* @constructor
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/examples/timeslider.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ exports.module.constant('angularLocaleScript', '../build/angular-locale_{{locale

/**
* @constructor
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {!ngeo.misc.WMSTime} ngeoWMSTime wmstime service.
* @ngInject
*/
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/src/backgroundlayerselector/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ exports.component('gmfBackgroundlayerselector',
* @constructor
* @private
* @struct
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {!ngeo.map.BackgroundLayerMgr} ngeoBackgroundLayerMgr Background layer manager.
* @param {!gmf.theme.Themes} gmfThemes Themes service.
* @ngInject
Expand Down
10 changes: 5 additions & 5 deletions contribs/gmf/src/contextualdata/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const exports = angular.module('gmfContextualdata', [
* @htmlAttribute {Function} callback A function called after server
* (raster) data is received in case some additional computing is required.
* Optional.
* @return {angular.Directive} The directive specs.
* @return {angular.IDirective} The directive specs.
* @ngdoc directive
* @ngname gmfContextualdata
*/
Expand All @@ -62,7 +62,7 @@ exports.directive_ = function() {
'callback': '<gmfContextualdataCallback'
},
/**
* @param {angular.Scope} scope Scope.
* @param {angular.IScope} scope Scope.
* @param {angular.JQLite} element Element.
* @param {angular.Attributes} attrs Attributes.
* @param {gmf.contextualdata.component.Controller_} controller Controller.
Expand All @@ -81,7 +81,7 @@ exports.directive('gmfContextualdata',
*
* @param {angular.ICompileService} $compile Angular compile service.
* @param {angular.ITimeoutService} $timeout Angular timeout service.
* @param {!angular.Scope} $scope Scope.
* @param {!angular.IScope} $scope Scope.
* @param {gmf.raster.RasterService} gmfRaster Gmf Raster service
*
* @constructor
Expand Down Expand Up @@ -128,7 +128,7 @@ exports.Controller_ = function($compile, $timeout, $scope, gmfRaster) {
this.timeout_ = $timeout;

/**
* @type {angular.Scope}
* @type {angular.IScope}
* @private
*/
this.$scope_ = $scope;
Expand Down Expand Up @@ -269,7 +269,7 @@ exports.controller('GmfContextualdataController', exports.Controller_);
* See the [../examples/contribs/gmf/contextualdata.html](../examples/contribs/gmf/contextualdata.html) example for a usage sample.
*
* @param {string} gmfContextualdatacontentTemplateUrl Url to template.
* @return {angular.Directive} The Directive Definition Object.
* @return {angular.IDirective} The Directive Definition Object.
* @ngInject
* @ngdoc directive
* @ngname gmfContextualdatacontent
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/src/controllers/AbstractAPIController.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import * as olInteraction from 'ol/interaction.js';
* by the HTML page and the controller to provide the configuration.
*
* @param {gmfx.Config} config A part of the application config.
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractAppController}
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/src/controllers/AbstractAppController.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import gmfThemeThemes from 'gmf/theme/Themes.js';
* by the HTML page and the controller to provide the configuration.
*
* @param {gmfx.Config} config A part of the application config.
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @ngdoc controller
Expand Down Expand Up @@ -388,7 +388,7 @@ const exports = function(config, $scope, $injector) {
this.tmhDynamicLocale = $injector.get('tmhDynamicLocale');

/**
* @type {angular.Scope}
* @type {angular.IScope}
*/
this.$scope = $scope;

Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/src/controllers/AbstractDesktopController.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import olStyleText from 'ol/style/Text.js';
* by the HTML page and the controller to provide the configuration.
*
* @param {gmfx.Config} config A part of the application config.
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractAppController}
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/src/controllers/AbstractMobileController.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import olStyleStyle from 'ol/style/Style.js';
* by the HTML page and the controller to provide the configuration.
*
* @param {gmfx.Config} config A part of the application config.
* @param {angular.Scope} $scope Scope.
* @param {angular.IScope} $scope Scope.
* @param {angular.IInjectorService} $injector Main injector.
* @constructor
* @extends {gmf.controllers.AbstractAppController}
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/src/datasource/ExternalDataSourcesManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const exports = class {
* @param {!angularGettext.Catalog} gettextCatalog service.
* @param {!angular.IInjectorService} $injector Main injector.
* @param {!angular.IQService} $q The Angular $q service.
* @param {!angular.Scope} $rootScope The rootScope provider.
* @param {!angular.IScope} $rootScope The rootScope provider.
* @param {!ngeo.datasource.DataSources} ngeoDataSources Ngeo data sources service.
* @param {!ngeo.misc.File} ngeoFile Ngeo file.
* @param {!ngeo.map.LayerHelper} ngeoLayerHelper Ngeo layer helper service
Expand All @@ -58,7 +58,7 @@ const exports = class {
this.q_ = $q;

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.rootScope_ = $rootScope;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/src/datasource/Manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const exports = class {
*
* @struct
* @param {angular.IQService} $q Angular q service
* @param {!angular.Scope} $rootScope Angular rootScope.
* @param {!angular.IScope} $rootScope Angular rootScope.
* @param {angular.ITimeoutService} $timeout Angular timeout service.
* @param {gmf.theme.Themes} gmfThemes The gmf Themes service.
* @param {gmf.layertree.TreeManager} gmfTreeManager The gmf TreeManager service.
Expand Down Expand Up @@ -70,7 +70,7 @@ const exports = class {
this.q_ = $q;

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.rootScope_ = $rootScope;
Expand Down
2 changes: 1 addition & 1 deletion contribs/gmf/src/disclaimer/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const exports = angular.module('gmfDisclaimer', [
* @constructor
* @private
* @param {!angular.JQLite} $element Element.
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {!angular.ISCEService} $sce Angular sce service.
* @param {!angular.ITimeoutService} $timeout Angular timeout service.
* @param {!angularGettext.Catalog} gettextCatalog Gettext catalog.
Expand Down
6 changes: 3 additions & 3 deletions contribs/gmf/src/drawing/drawFeatureComponent.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ exports.run(/* @ngInject */ ($templateCache) => {
* @htmlAttribute {boolean} gmf-drawfeature-active Whether the directive is
* active or not.
* @htmlAttribute {ol.Map} gmf-drawfeature-map The map.
* @return {angular.Directive} The directive specs.
* @return {angular.IDirective} The directive specs.
* @ngInject
* @ngdoc directive
* @ngname gmfDrawfeature
Expand All @@ -92,7 +92,7 @@ exports.directive('gmfDrawfeature',


/**
* @param {!angular.Scope} $scope Angular scope.
* @param {!angular.IScope} $scope Angular scope.
* @param {!angular.ITimeoutService} $timeout Angular timeout service.
* @param {!angularGettext.Catalog} gettextCatalog Gettext catalog.
* @param {!ngeo.misc.FeatureHelper} ngeoFeatureHelper Ngeo feature helper service.
Expand Down Expand Up @@ -155,7 +155,7 @@ exports.Controller_ = function($scope, $timeout, gettextCatalog,
this.mapSelectToolActivate = new ngeoMiscToolActivate(this, 'mapSelectActive');

/**
* @type {!angular.Scope}
* @type {!angular.IScope}
* @private
*/
this.scope_ = $scope;
Expand Down
Loading