Small documentation improvements

contribs/gmf/src/backgroundlayerselector/component.js

@@ -61,11 +61,11 @@ function gmfBackgroundlayerselectorTemplateUrl($element, $attrs, gmfBackgroundla
  *
  * Used metadata:
  *
- *  * thumbnail: The URL used for the icon.
+ *  * `thumbnail`: The URL used for the icon.
  *
  * Used functionnalities:
  *
- *  * default_basemap: Base maps to use by default.
+ *  * `default_basemap`: Base maps to use by default.
  *
  * @htmlAttribute {import("ol/Map.js").default=} gmf-backgroundlayerselector-map The map.
  * @htmlAttribute {string} gmf-backgroundlayer-opacity-options The opacity slider options.

contribs/gmf/src/controllers/AbstractAppController.js

@@ -53,12 +53,9 @@ import {ThemeEventType} from 'gmf/theme/Manager.js';
 /**
  * Application abstract controller.
  *
- * This file includes `goog.require` for base components/directives used
- * by the HTML page and the controller to provide the configuration.
- *
  * Used functionnalities:
  *
- *  * open_panel: When set, contains the name of the panel to open upon loading an application.
+ *  * `open_panel`: When set, contains the name of the panel to open upon loading an application.
  *      Note: although this is a list, only one can be defined.
  *
  *

contribs/gmf/src/controllers/AbstractDesktopController.js

@@ -228,6 +228,7 @@ export class AbstractDesktopController extends AbstractAPIController {
    * If, after resizing, the size of the data panel would be too big,
    * resize it as well.
    * @private
+   * @hidden
    */
   setDataPanelMaxResizableWidth_() {
 

contribs/gmf/src/datasource/Manager.js

@@ -54,7 +54,7 @@ import olSourceTileWMS from 'ol/source/TileWMS.js';
  *
  * Used metadata:
  *
- *  * identifierAttributeField: The field used in the 'display query window' as feature title.
+ *  * `identifierAttributeField`: The field used in the 'display query window' as feature title.
  *      For WMS layers.
  */
 export class DatasourceManager {
@@ -218,7 +218,9 @@ export class DatasourceManager {
 
   /**
    * Set the map to use with your datasources.
+   *
    * @param {!import("ol/Map.js").default} map The map to use.
+   * @hidden
    */
   setDatasourceMap(map) {
     this.ngeoDataSources_.map = map;
@@ -227,6 +229,7 @@ export class DatasourceManager {
   /**
    * @param {!import('ngeo/datasource/OGC.js').Dimensions} dimensions A reference to the dimensions
    *     object to keep a reference of in this service.
+   * @hidden
    */
   setDimensions(dimensions) {
     if (this.dimensionsWatcherUnregister) {
@@ -246,6 +249,7 @@ export class DatasourceManager {
   /**
    * Called when the dimensions change. Update all affected layer's filters.
    * @private
+   * @hidden
    */
   handleDimensionsChange_() {
 
@@ -280,6 +284,7 @@ export class DatasourceManager {
    * Called when the themes change. Remove any existing data sources first,
    * then create and add data sources from the loaded themes.
    * @private
+   * @hidden
    */
   handleThemesChange_() {
     // (1) Clear
@@ -340,6 +345,7 @@ export class DatasourceManager {
    * @param {Array.<import("ngeo/layertree/Controller.js").LayertreeController>|undefined} value List of tree
    *     controllers.
    * @private
+   * @hidden
    */
   handleTreeManagerRootChildrenChange_(value) {
 
@@ -389,6 +395,7 @@ export class DatasourceManager {
    * Remove the data sources from the ngeo collection that are in the cache,
    * i.e. those created by this service, then clear the cache.
    * @private
+   * @hidden
    */
   clearDataSources_() {
 
@@ -420,6 +427,7 @@ export class DatasourceManager {
    *     may have children or not.
    * @param {!import('gmf/themes.js').GmfOgcServers} ogcServers OGC servers.
    * @private
+   * @hidden
    */
   createDataSource_(firstLevelGroup, node, ogcServers) {
 
@@ -605,6 +613,7 @@ export class DatasourceManager {
    *
    * @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl Layertree controller to add
    * @private
+   * @hidden
    */
   addTreeCtrlToCache_(treeCtrl) {
 
@@ -667,9 +676,9 @@ export class DatasourceManager {
    * Remove a treeCtrl cache item. Unregister event listeners and remove the
    * data source from the ngeo collection.
    *
-   * @param {ManagerTreeCtrlCacheItem} item Layertree
-   *     controller cache item
+   * @param {ManagerTreeCtrlCacheItem} item Layertree controller cache item
    * @private
+   * @hidden
    */
   removeTreeCtrlCacheItem_(item) {
 
@@ -697,6 +706,7 @@ export class DatasourceManager {
    *
    * The data source gets also removed from the ngeo data sources collection.
    * @private
+   * @hidden
    */
   clearTreeCtrlCache_() {
     for (const id in this.treeCtrlCache_) {
@@ -715,6 +725,7 @@ export class DatasourceManager {
    * @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
    * @param {string|undefined} newVal New state value
    * @private
+   * @hidden
    */
   handleTreeCtrlStateChange_(treeCtrl, newVal) {
     const treeDataSource = treeCtrl.getDataSource();
@@ -738,6 +749,7 @@ export class DatasourceManager {
    * @param {import("ngeo/layertree/Controller.js").LayertreeController} treeCtrl The layer tree controller
    * @return {ManagerTreeCtrlCacheItem} Cache item
    * @private
+   * @hidden
    */
   getTreeCtrlCacheItem_(treeCtrl) {
     return this.treeCtrlCache_[olUtilGetUid(treeCtrl.node)] || null;
@@ -748,6 +760,7 @@ export class DatasourceManager {
    * @param {!import("ngeo/datasource/DataSource.js").default} dataSource The data source.
    * @return {import("ol/layer/Base.js").default|undefined} The layer.
    * @private
+   * @hidden
    */
   getDataSourceLayer_(dataSource) {
     const gmfOGCDataSource = /** @type {!import("gmf/datasource/OGC.js").default} */ (dataSource);
@@ -771,6 +784,7 @@ export class DatasourceManager {
    * and dimensions filters.
    * @param {import("ol/layer/Base.js").default} layer The layer to update.
    * @private
+   * @hidden
    */
   updateLayerFilter_(layer) {
     console.assert(
@@ -845,6 +859,7 @@ export class DatasourceManager {
    *
    * @param {!import("gmf/datasource/OGC.js").default} dataSource Data source.
    * @private
+   * @hidden
    */
   handleDataSourceFilterRulesChange_(dataSource) {
 
@@ -873,6 +888,7 @@ export class DatasourceManager {
    *
    * @param {!import("gmf/datasource/OGC.js").default} dataSource Data source.
    * @private
+   * @hidden
    */
   handleDataSourceTimeValueChange_(dataSource) {
 
@@ -915,6 +931,7 @@ export class DatasourceManager {
    *
    * @param {!import('ngeo/map/BackgroundLayerMgr.js').BackgroundEvent} evt Event.
    * @private
+   * @hidden
    */
   handleNgeoBackgroundLayerChange_(evt) {
 

contribs/gmf/src/disclaimer/component.js

@@ -40,7 +40,7 @@ function forEachDisclaimer(layer, func) {
 /**
  * Used metadata:
  *
- *  * disclaimer: The disclaimer text for this element.
+ *  * `disclaimer`: The disclaimer text for this element.
  *      For WMS and WMTS layers, layer groups and themes.
  *
  * @param {!JQuery} $element Element.

contribs/gmf/src/editing/editFeatureComponent.js

@@ -127,9 +127,9 @@ module.run(/* @ngInject */ ($templateCache) => {
  *
  * Used metadata:
  *
- *  * enumeratedAttributes: List of attribute names which have enumerated attribute
+ *  * `enumeratedAttributes`: List of attribute names which have enumerated attribute
  *      values (for filters purpose). For WMS layers.
- *  * snappingConfig: The snapping configuration for the leaf. If set, the leaf's layer is considered to be
+ *  * `snappingConfig`: The snapping configuration for the leaf. If set, the leaf's layer is considered to be
  *      "snappable", even if the config itself is empty.
  *      Example of value: {'tolerance': 50, 'edge': false} For WMS layers.
  *

contribs/gmf/src/filters/filterselectorComponent.js

@@ -77,15 +77,15 @@ function gmfFilterselectorTemplateUrl($attrs, gmfFilterselectorTemplateUrl) {
  *
  * Used metadata:
  *
- *  * directedFilterAttributes: List of attribute names which should have rules
+ *  * `directedFilterAttributes`: List of attribute names which should have rules
  *      already ready when using the filter tools. For WMS layers.
  *
  * Used functionnalities:
  *
- *  * preset_layer_filter: Name of the layer (data source) that should be toggled in the filter tool upon
+ *  * `preset_layer_filter`: Name of the layer (data source) that should be toggled in the filter tool upon
  *      loading an application.
  *      Note: although this is a list, only one can be defined.
- *  * filterable_layers: A list of layer names that can be filtered, if empty the component will be hidden.
+ *  * `filterable_layers`: A list of layer names that can be filtered, if empty the component will be hidden.
  */
 class FilterSelectorController {
 
@@ -316,6 +316,7 @@ class FilterSelectorController {
 
   /**
    * @private
+   * @hidden
    */
   handleGmfUserFunctionalitiesChange_() {
     const usrFunc = this.gmfUser_.functionalities;
@@ -335,6 +336,7 @@ class FilterSelectorController {
 
   /**
    * @private
+   * @hidden
    */
   toggleDataSourceRegistration_() {
     const newDataSourceRegistration = !!this.filtrableLayerNodeNames_;
@@ -349,6 +351,7 @@ class FilterSelectorController {
    * Also, when deactivated, deselect data source.
    * @param {boolean} active Active.
    * @private
+   * @hidden
    */
   handleActiveChange_(active) {
     if (!active) {
@@ -363,6 +366,7 @@ class FilterSelectorController {
   /**
    * @param {boolean} register Whether register the data sources or not.
    * @private
+   * @hidden
    */
   handleEnableDataSourceRegistrationChange_(register) {
     const keys = this.listenerKeys_;
@@ -394,6 +398,7 @@ class FilterSelectorController {
    *
    * @param {import("ol/Collection.js").CollectionEvent} evt Collection event.
    * @private
+   * @hidden
    */
   handleDataSourcesAdd_(evt) {
     const dataSource = evt.element;
@@ -410,6 +415,7 @@ class FilterSelectorController {
    *
    * @param {import("ol/Collection.js").CollectionEvent} evt Collection event.
    * @private
+   * @hidden
    */
   handleDataSourcesRemove_(evt) {
     const dataSource = evt.element;
@@ -426,6 +432,7 @@ class FilterSelectorController {
    *
    * @param {import("gmf/datasource/OGC.js").default} dataSource Data source
    * @private
+   * @hidden
    */
   registerDataSource_(dataSource) {
     if (dataSource.filtrable === null) {
@@ -449,6 +456,7 @@ class FilterSelectorController {
    * that was currently selected, deselect it.
    * @param {import("gmf/datasource/OGC.js").default} dataSource Data source
    * @private
+   * @hidden
    */
   unregisterDataSource_(dataSource) {
     if (dataSource.filtrable) {
@@ -483,6 +491,7 @@ class FilterSelectorController {
    * @return {boolean} Whether the data source is valid to add to the list or
    *     not.
    * @private
+   * @hidden
    */
   isDataSourceFiltrable_(dataSource, opt_notify) {
     let filtrable = true;
@@ -545,6 +554,7 @@ class FilterSelectorController {
   /**
    * @param {?import("gmf/datasource/OGC.js").default} dataSource Newly selected data source object.
    * @private
+   * @hidden
    */
   handleSelectedDataSourceChange_(dataSource) {
 
@@ -602,6 +612,7 @@ class FilterSelectorController {
    * @param {import("ngeo/datasource/DataSource.js").default} dataSource Data source.
    * @return {?RuleCacheItem} Rule cache item.
    * @private
+   * @hidden
    */
   getRuleCacheItem_(dataSource) {
     return this.ruleCache_[dataSource.id] || null;
@@ -611,18 +622,21 @@ class FilterSelectorController {
    * @param {import("ngeo/datasource/DataSource.js").default} dataSource Data source.
    * @param {RuleCacheItem} item Rule cache item.
    * @private
+   * @hidden
    */
   setRuleCacheItem_(dataSource, item) {
     this.ruleCache_[dataSource.id] = item;
   }
 
   /**
+   * @hidden
    */
   saveFilterShowModal() {
     this.saveFilterSaveModalShown = true;
   }
 
   /**
+   * @hidden
    */
   saveFilterSave() {
 
@@ -661,7 +675,9 @@ class FilterSelectorController {
 
   /**
    * Load a saved filter item, replacing the current rules.
+   *
    * @param {!import("gmf/filters/SavedFilters.js").SavedFilterItem} filterItem Filter item.
+   * @hidden
    */
   saveFilterLoadItem(filterItem) {
 
@@ -694,14 +710,17 @@ class FilterSelectorController {
   }
 
   /**
+   * @hidden
    */
   saveFilterManage() {
     this.saveFilterManageModalShown = true;
   }
 
   /**
    * Remove a saved filter item.
+   *
    * @param {!import("gmf/filters/SavedFilters.js").SavedFilterItem} item Filter item.
+   * @hidden
    */
   saveFilterRemoveItem(item) {
     this.gmfSavedFilters.remove(item);