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

Fix types in gmf #4563

Merged
merged 8 commits into from
Jan 30, 2019
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions contribs/gmf/examples/displayquerygrid.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ module.component('gmfappQueryresult', queryresultComponent);

/**
* Demo, NOT USED.
* @param {QueryResult} ngeoQueryResult Query service.
* @param {import('ngeo/query/MapQuerent.js').QueryResult} ngeoQueryResult Query service.
* @constructor
* @ngInject
*/
function QueryresultController(ngeoQueryResult) {

/**
* @type {QueryResult}
* @type {import('ngeo/query/MapQuerent.js').QueryResult}
* @export
*/
this.result = ngeoQueryResult;
Expand Down
4 changes: 2 additions & 2 deletions contribs/gmf/examples/displayquerywindow.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@ module.component('appQueryresult', queryresultComponent);

/**
* Demo, NOT USED.
* @param {QueryResult} ngeoQueryResult Query service.
* @param {import('ngeo/query/MapQuerent.js').QueryResult} ngeoQueryResult Query service.
* @constructor
* @ngInject
*/
function QueryresultController(ngeoQueryResult) {

/**
* @type {QueryResult}
* @type {import('ngeo/query/MapQuerent.js').QueryResult}
* @export
*/
this.result = ngeoQueryResult;
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 @@ -39,7 +39,7 @@ module.constant('angularLocaleScript', '../build/angular-locale_{{locale}}.js');
/**
* @param {!angular.IScope} $scope Angular scope.
* @param {import("gmf/editing/EditFeature.js").EditingEditFeature} gmfEditFeature Gmf edit feature service.
* @param {User} gmfUser User.
* @param {import('gmf/authentication/Service.js').User} gmfUser User.
* @constructor
* @ngInject
*/
Expand All @@ -58,7 +58,7 @@ function MainController($scope, gmfEditFeature, gmfUser) {
this.editFeature_ = gmfEditFeature;

/**
* @type {User}
* @type {import('gmf/authentication/Service.js').User}
* @export
*/
this.gmfUser = gmfUser;
Expand Down
7 changes: 2 additions & 5 deletions contribs/gmf/examples/editfeatureselector.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/**
*/

import angular from 'angular';
import appURL from './url.js';
import './editfeatureselector.css';
Expand Down Expand Up @@ -54,7 +51,7 @@ module.constant('angularLocaleScript', '../build/angular-locale_{{locale}}.js');
* @param {!angular.IScope} $scope Angular scope.
* @param {import("gmf/theme/Themes.js").ThemesService} gmfThemes The gmf themes service.
* @param {import("gmf/layertree/TreeManager.js").LayertreeTreeManager} gmfTreeManager gmf Tree Manager service.
* @param {User} gmfUser User.
* @param {import('gmf/authentication/Service.js').User} gmfUser User.
* @param {import("ngeo/misc/FeatureHelper.js").FeatureHelper} ngeoFeatureHelper Ngeo feature helper service.
* @param {import("ngeo/misc/ToolActivateMgr.js").ToolActivateMgr} ngeoToolActivateMgr Ngeo ToolActivate manager
* service.
Expand All @@ -71,7 +68,7 @@ function MainController($scope, gmfThemes, gmfTreeManager, gmfUser,
this.scope_ = $scope;

/**
* @type {User}
* @type {import('gmf/authentication/Service.js').User}
* @export
*/
this.gmfUser = gmfUser;
Expand Down
29 changes: 13 additions & 16 deletions contribs/gmf/examples/layertree.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/**
*/

import angular from 'angular';
import appURL from './url.js';
import './layertree.css';
Expand Down Expand Up @@ -94,26 +91,26 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
this.gmfThemeManager = gmfThemeManager;

/**
* @type {Array.<import(gmf/themes.js).GmfTheme>}
* @type {Array.<import('gmf/themes.js').GmfTheme>}
* @export
*/
this.themes = [];

/**
* @type {Array.<import(gmf/themes.js).GmfGroup>}
* @type {Array.<import('gmf/themes.js').GmfGroup>}
* @export
*/
this.groups = [];

/**
* @type {Array.<import(gmf/themes.js).GmfLayer>}
* @type {Array.<import('gmf/themes.js').GmfLayer>}
* @export
*/
this.layers = [];

/**
* @param {import(gmf/themes.js).GmfTheme|undefined} value A theme or undefined to get Themes.
* @return {Array.<import(gmf/themes.js).GmfTheme>} All themes.
* @param {import('gmf/themes.js').GmfTheme|undefined} value A theme or undefined to get Themes.
* @return {Array.<import('gmf/themes.js').GmfTheme>} All themes.
* @export
*/
this.getSetTheme = function(value) {
Expand All @@ -124,8 +121,8 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
};

/**
* @param {import(gmf/themes.js).GmfGroup|undefined} value A group or undefined to get groups.
* @return {Array.<import(gmf/themes.js).GmfGroup>} All groups in all themes.
* @param {import('gmf/themes.js').GmfGroup|undefined} value A group or undefined to get groups.
* @return {Array.<import('gmf/themes.js').GmfGroup>} All groups in all themes.
* @export
*/
this.getSetGroup = function(value) {
Expand All @@ -136,8 +133,8 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
};

/**
* @param {import(gmf/themes.js).GmfLayer|undefined} value A group or undefined to get groups.
* @return {Array.<import(gmf/themes.js).GmfLayer>} All groups in all themes.
* @param {import('gmf/themes.js').GmfLayer|undefined} value A group or undefined to get groups.
* @return {Array.<import('gmf/themes.js').GmfLayer>} All groups in all themes.
* @export
*/
this.getSetLayers = function(value) {
Expand All @@ -148,9 +145,9 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
};

/**
* @param {import(gmf/themes.js).GmfGroup|undefined} value A GeoMapFish group, or undefined
* @param {import('gmf/themes.js').GmfGroup|undefined} value A GeoMapFish group, or undefined
* to get the groups of the tree manager.
* @return {Array.<import(gmf/themes.js).GmfGroup>} All groups in the tree manager.
* @return {Array.<import('gmf/themes.js').GmfGroup>} All groups in the tree manager.
* @export
*/
this.getSetRemoveTree = function(value) {
Expand Down Expand Up @@ -183,8 +180,8 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation

/**
* Just for this example
* @param {import(gmf/themes.js).GmfTheme|import(gmf/themes.js).GmfGroup|import(gmf/themes.js).GmfLayer} node A theme, group or layer node.
* @param {Array.<import(gmf/themes.js).GmfTheme|import(gmf/themes.js).GmfGroup|import(gmf/themes.js).GmfLayer>} nodes An Array of nodes.
* @param {import('gmf/themes.js').GmfTheme|import('gmf/themes.js').GmfGroup|import('gmf/themes.js').GmfLayer} node A theme, group or layer node.
* @param {Array.<import('gmf/themes.js').GmfTheme|import('gmf/themes.js').GmfGroup|import('gmf/themes.js').GmfLayer>} nodes An Array of nodes.
* @export
*/
this.getDistinctFlatNodes_ = function(node, nodes) {
Expand Down
29 changes: 13 additions & 16 deletions contribs/gmf/examples/layertreeadd.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/**
*/

import angular from 'angular';
import appURL from './url.js';
import './layertreeadd.css';
Expand Down Expand Up @@ -93,26 +90,26 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
this.gmfThemeManager = gmfThemeManager;

/**
* @type {Array.<import(gmf/themes.js).GmfTheme>}
* @type {Array.<import('gmf/themes.js').GmfTheme>}
* @export
*/
this.themes = [];

/**
* @type {Array.<import(gmf/themes.js).GmfGroup>}
* @type {Array.<import('gmf/themes.js').GmfGroup>}
* @export
*/
this.groups = [];

/**
* @type {Array.<import(gmf/themes.js).GmfLayer>}
* @type {Array.<import('gmf/themes.js').GmfLayer>}
* @export
*/
this.layers = [];

/**
* @param {import(gmf/themes.js).GmfTheme|undefined} value A theme or undefined to get Themes.
* @return {Array.<import(gmf/themes.js).GmfTheme>} All themes.
* @param {import('gmf/themes.js').GmfTheme|undefined} value A theme or undefined to get Themes.
* @return {Array.<import('gmf/themes.js').GmfTheme>} All themes.
* @export
*/
this.getSetTheme = function(value) {
Expand All @@ -123,8 +120,8 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
};

/**
* @param {import(gmf/themes.js).GmfGroup|undefined} value A group or undefined to get groups.
* @return {Array.<import(gmf/themes.js).GmfGroup>} All groups in all themes.
* @param {import('gmf/themes.js').GmfGroup|undefined} value A group or undefined to get groups.
* @return {Array.<import('gmf/themes.js').GmfGroup>} All groups in all themes.
* @export
*/
this.getSetGroup = function(value) {
Expand All @@ -135,8 +132,8 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
};

/**
* @param {import(gmf/themes.js).GmfLayer|undefined} value A group or undefined to get groups.
* @return {Array.<import(gmf/themes.js).GmfLayer>} All groups in all themes.
* @param {import('gmf/themes.js').GmfLayer|undefined} value A group or undefined to get groups.
* @return {Array.<import('gmf/themes.js').GmfLayer>} All groups in all themes.
* @export
*/
this.getSetLayers = function(value) {
Expand All @@ -147,9 +144,9 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation
};

/**
* @param {import(gmf/themes.js).GmfGroup|undefined} value A GeoMapFish group node, or undefined
* @param {import('gmf/themes.js').GmfGroup|undefined} value A GeoMapFish group node, or undefined
* to get the groups of the tree manager.
* @return {Array.<import(gmf/themes.js).GmfGroup>} All groups in the tree manager.
* @return {Array.<import('gmf/themes.js').GmfGroup>} All groups in the tree manager.
* @export
*/
this.getSetRemoveTree = function(value) {
Expand Down Expand Up @@ -182,8 +179,8 @@ function MainController(gmfTreeManager, gmfThemes, gmfThemeManager, ngeoLocation

/**
* Just for this example
* @param {import(gmf/themes.js).GmfTheme|import(gmf/themes.js).GmfGroup|import(gmf/themes.js).GmfLayer} node A theme, group or layer node.
* @param {Array.<import(gmf/themes.js).GmfTheme|import(gmf/themes.js).GmfGroup|import(gmf/themes.js).GmfLayer>} nodes An Array of nodes.
* @param {import('gmf/themes.js').GmfTheme|import('gmf/themes.js').GmfGroup|import('gmf/themes.js').GmfLayer} node A theme, group or layer node.
* @param {Array.<import('gmf/themes.js').GmfTheme|import('gmf/themes.js').GmfGroup|import('gmf/themes.js').GmfLayer>} nodes An Array of nodes.
* @export
*/
this.getDistinctFlatNodes_ = function(node, nodes) {
Expand Down
24 changes: 12 additions & 12 deletions contribs/gmf/examples/objecteditinghub.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,25 +99,25 @@ function MainController($http, $q, $scope, gmfThemes, gmfXSDAttributes) {
this.selectedUrl = this.urls[0];

/**
* @type {import(gmf/themes.js).GmfOgcServers} ogcServers OGC servers.
* @type {import('gmf/themes.js').GmfOgcServers} ogcServers OGC servers.
* @private
*/
this.gmfServers_;

/**
* @type {import(gmf/themes.js).GmfOgcServer} ogcServer OGC server to use.
* @type {import('gmf/themes.js').GmfOgcServer} ogcServer OGC server to use.
* @private
*/
this.gmfServer_;

/**
* @type {Array.<import(gmf/themes.js).GmfLayerWMS>}
* @type {Array.<import('gmf/themes.js').GmfLayerWMS>}
* @export
*/
this.gmfLayerNodes = [];

/**
* @type {?import(gmf/themes.js).GmfLayerWMS}
* @type {?import('gmf/themes.js').GmfLayerWMS}
* @export
*/
this.selectedGmfLayerNode = null;
Expand Down Expand Up @@ -302,7 +302,7 @@ MainController.prototype.runViewer_ = function(baseUrl) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @return {angular.IPromise} The promise attached to the deferred object.
* @private
*/
Expand All @@ -323,7 +323,7 @@ MainController.prototype.getFeatures_ = function(gmfLayerNode) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @private
*/
MainController.prototype.issueGetFeatures_ = function(gmfLayerNode) {
Expand All @@ -349,7 +349,7 @@ MainController.prototype.issueGetFeatures_ = function(gmfLayerNode) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @private
*/
MainController.prototype.handleGetFeatures_ = function(gmfLayerNode) {
Expand All @@ -361,7 +361,7 @@ MainController.prototype.handleGetFeatures_ = function(gmfLayerNode) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @return {?Array.<import("ol/Feature.js").default>} List of features
* @private
*/
Expand All @@ -373,7 +373,7 @@ MainController.prototype.getFeaturesFromCache_ = function(gmfLayerNode) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @return {angular.IPromise} The promise attached to the deferred object.
* @private
*/
Expand All @@ -394,7 +394,7 @@ MainController.prototype.getGeometryType_ = function(gmfLayerNode) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @private
*/
MainController.prototype.issueGetAttributesRequest_ = function(
Expand All @@ -416,7 +416,7 @@ MainController.prototype.issueGetAttributesRequest_ = function(


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @private
*/
MainController.prototype.handleGetGeometryType_ = function(gmfLayerNode) {
Expand All @@ -426,7 +426,7 @@ MainController.prototype.handleGetGeometryType_ = function(gmfLayerNode) {


/**
* @param {import(gmf/themes.js).GmfLayerWMS} gmfLayerNode Layer node.
* @param {import('gmf/themes.js').GmfLayerWMS} gmfLayerNode Layer node.
* @return {string|undefined} The type of geometry.
* @private
*/
Expand Down
5 changes: 1 addition & 4 deletions contribs/gmf/examples/themeselector.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/**
*/

import angular from 'angular';
import appURL from './url.js';
import './themeselector.css';
Expand Down Expand Up @@ -30,7 +27,7 @@ module.constant('angularLocaleScript', '../build/angular-locale_{{locale}}.js');
function MainController($http, gmfThemes, gmfThemeManager) {

/**
* @param {import(gmf/themes.js).GmfTheme} theme Theme.
* @param {import('gmf/themes.js').GmfTheme} theme Theme.
* @return {boolean} Theme is 'Enseignement'
* @export
*/
Expand Down