diff --git a/config/jsdoc/api/conf.json b/config/jsdoc/api/conf.json index 13cf7460f1..9c46eba800 100644 --- a/config/jsdoc/api/conf.json +++ b/config/jsdoc/api/conf.json @@ -1,6 +1,7 @@ { "opts": { - "recurse": true + "recurse": true, + "template": "config/jsdoc/api/template" }, "tags": { "allowUnknownTags": true diff --git a/config/jsdoc/api/index.md b/config/jsdoc/api/index.md index 48cc20a3f9..4817f900f6 100644 --- a/config/jsdoc/api/index.md +++ b/config/jsdoc/api/index.md @@ -1,43 +1,43 @@
| Map | View | Layers | ||
|---|---|---|---|---|
A [map](ol.Map.html) is made of [layers](ol.layer.html), a [view](ol.View.html) to visualize them, [interactions](ol.interaction.html) to modify map content and [controls](ol.control.html) with UI components. -[Overview](ol.Map.html)-[Creation](ol.Map.html#Map) -[Events](ol.MapBrowserEvent.html) |
+A [map](module-ol_Map-Map.html) is made of [layers](module-ol_layer_Base-BaseLayer.html), a [view](module-ol_View-View.html) to visualize them, [interactions](module-ol_interaction_Interaction-Interaction.html) to modify map content and [controls](module-ol_control_Control-Control.html) with UI components. +[Overview](module-ol_Map-Map.html)+[Creation](module-ol_Map-Map.html#Map) +[Events](module-ol_MapBrowserEvent-MapBrowserEvent.html) |
The view manages the visual parameters of the map view, like resolution or rotation. -[ol.View](ol.View.html) with center, projection, resolution and rotation |
-Layers are lightweight containers that get their data from [sources](ol.source.html). -[ol.layer.Tile](ol.layer.Tile.html)-[ol.layer.Image](ol.layer.Image.html) -[ol.layer.Vector](ol.layer.Vector.html) -[ol.layer.VectorTile](ol.layer.VectorTile.html) |
+[View](module-ol_View-View.html) with center, projection, resolution and rotation
+Layers are lightweight containers that get their data from [sources](module-ol_source_Source-Source.html). +[layer/Tile](module-ol_layer_Tile-TileLayer.html)+[layer/Image](module-ol_layer_Image-ImageLayer.html) +[layer/Vector](module-ol_layer_Vector-VectorLayer.html) +[layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html) |
| Controls | Interactions | Sources and formats | ||
| [Map default controls](ol.control.html#.defaults) -[All controls](ol.control.html) + | [Map default controls](module-ol_control_util.html#.defaults) +[All controls](module-ol_control_Control-Control.html) |
-[Map default interactions](ol.interaction.html#.defaults) -Interactions for [vector features](ol.Feature.html) -
|
-[Tile sources](ol.source.Tile.html) for [ol.layer.Tile](ol.layer.Tile.html)
- [Image sources](ol.source.Image.html) for [ol.layer.Image](ol.layer.Image.html) - [Vector sources](ol.source.Vector.html) for [ol.layer.Vector](ol.layer.Vector.html) - [Vector tile sources](ol.source.VectorTile.html) for [ol.layer.VectorTile](ol.layer.VectorTile.html) - [Formats](ol.format.Feature.html) for reading/writing vector data - [ol.format.WMSCapabilities](ol.format.WMSCapabilities.html) | [Tile sources](module-ol_source_Tile-TileSource.html) for [layer/Tile](module-ol_layer_Tile-TileLayer.html)
+ [Image sources](module-ol_source_Image-ImageSource.html) for [layer/Image](module-ol_layer_Image-ImageLayer.html) + [Vector sources](module-ol_source_Vector-VectorSource.html) for [layer/Vector](module-ol_layer_Vector-VectorLayer.html) + [Vector tile sources](module-ol_source_VectorTile-VectorTile.html) for [layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html) + [Formats](module-ol_format_Feature-FeatureFormat.html) for reading/writing vector data + [format/WMSCapabilities](module-ol_format_WMSCapabilities-WMSCapabilities.html) |
| Projections | Observable objects | Other components | ||
All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use [ol.proj.transform()](ol.proj.html#.transform) and [ol.proj.transformExtent()](ol.proj.html#.transformExtent). -[ol.proj](ol.proj.html) |
-Changes to all [ol.Objects](ol.Object.html) can be observed by calling the [object.on('propertychange')](ol.Object.html#on) method. Listeners receive an [ol.Object.Event](ol.Object.Event.html) with information on the changed property and old value. + | |||
All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use [proj.transform()](module-ol_proj.html#.transform) and [proj.transformExtent()](module-ol_proj.html#.transformExtent). +[ol/proj](module-ol_proj.html) |
+Changes to all [ol/Object](module-ol_Object-BaseObject.html)s can be observed by calling the [object.on('propertychange')](module-ol_Object-BaseObject.html#on) method. Listeners receive an [ol/Object~ObjectEvent](module-ol_Object-ObjectEvent.html) with information on the changed property and old value. |
-[ol.Geolocation](ol.Geolocation.html) -[ol.Overlay](ol.Overlay.html) |
+[ol/Geolocation](module-ol_Geolocation.html)
import from '';
diff --git a/config/jsdoc/api/template/tmpl/navigation.tmpl b/config/jsdoc/api/template/tmpl/navigation.tmpl
index 2fe64ace28..f57d604640 100644
--- a/config/jsdoc/api/template/tmpl/navigation.tmpl
+++ b/config/jsdoc/api/template/tmpl/navigation.tmpl
@@ -11,7 +11,7 @@ var self = this;
?>