Skip to content

Commit 523ad3b

Browse files
mfazekaskristfal
mfazekas
authored and
kristfal
committed
Add autogenerated warning to generated docs (#478)
1 parent 94d831a commit 523ad3b

23 files changed

+23
-0
lines changed

‎docs/Annotation.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from Annotation.js do not modify -->
12
## <MapboxGL.Annotation />
23
###
34

‎docs/BackgroundLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from BackgroundLayer.js do not modify -->
12
## <MapboxGL.BackgroundLayer />
23
###
34

‎docs/Callout.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from Callout.js do not modify -->
12
## <MapboxGL.Callout />
23
### Callout that displays information about a selected annotation near the annotation.
34

‎docs/Camera.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from Camera.js do not modify -->
12
## <MapboxGL.Camera />
23
###
34

‎docs/CircleLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from CircleLayer.js do not modify -->
12
## <MapboxGL.CircleLayer />
23
### CircleLayer is a style layer that renders one or more filled circles on the map.
34

‎docs/FillExtrusionLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from FillExtrusionLayer.js do not modify -->
12
## <MapboxGL.FillExtrusionLayer />
23
### FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.
34

‎docs/FillLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from FillLayer.js do not modify -->
12
## <MapboxGL.FillLayer />
23
### FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.
34

‎docs/HeatmapLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from HeatmapLayer.js do not modify -->
12
## <MapboxGL.HeatmapLayer />
23
### HeatmapLayer is a style layer that renders one or more filled circles on the map.
34

‎docs/ImageSource.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from ImageSource.js do not modify -->
12
## <MapboxGL.ImageSource />
23
### ImageSource is a content source that is used for a georeferenced raster image to be shown on the map.<br/>The georeferenced image scales and rotates as the user zooms and rotates the map
34

‎docs/Images.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from Images.js do not modify -->
12
## <MapboxGL.Images />
23
### Images defines the images used in Symbol etc layers
34

‎docs/Light.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from Light.js do not modify -->
12
## <MapboxGL.Light />
23
### Light represents the light source for extruded geometries
34

‎docs/LineLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from LineLayer.js do not modify -->
12
## <MapboxGL.LineLayer />
23
### LineLayer is a style layer that renders one or more stroked polylines on the map.
34

‎docs/MapView.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from MapView.js do not modify -->
12
## <MapboxGL.MapView />
23
### MapView backed by Mapbox Native GL
34

‎docs/OfflineManager.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from offlineManager.js do not modify -->
12
## <MapboxGL.offlineManager />
23
### OfflineManager implements a singleton (shared object) that manages offline packs.<br/>All of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.<br/>The shared object maintains a canonical collection of offline packs.
34

‎docs/PointAnnotation.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from PointAnnotation.js do not modify -->
12
## <MapboxGL.PointAnnotation />
23
### PointAnnotation represents a one-dimensional shape located at a single geographical coordinate. PointAnnotation is legacy, soon to be deprecated, and should use ShapeSource and SymbolLayer instead.
34

‎docs/RasterLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from RasterLayer.js do not modify -->
12
## <MapboxGL.RasterLayer />
23
###
34

‎docs/RasterSource.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from RasterSource.js do not modify -->
12
## <MapboxGL.RasterSource />
23
### RasterSource is a map content source that supplies raster image tiles to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary<br/>or by an external file that conforms to the TileJSON specification.
34

‎docs/ShapeSource.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from ShapeSource.js do not modify -->
12
## <MapboxGL.ShapeSource />
23
### ShapeSource is a map content source that supplies vector shapes to be shown on the map.<br/>The shape may be a url or a GeoJSON object
34

‎docs/SymbolLayer.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from SymbolLayer.js do not modify -->
12
## <MapboxGL.SymbolLayer />
23
### SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.
34

‎docs/UserLocation.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from UserLocation.js do not modify -->
12
## <MapboxGL.UserLocation />
23
###
34

‎docs/VectorSource.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from VectorSource.js do not modify -->
12
## <MapboxGL.VectorSource />
23
### VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.
34

‎docs/snapshotManager.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- This file was autogenerated from snapshotManager.js do not modify -->
12
## <MapboxGL.snapshotManager />
23
### The snapshotManager generates static raster images of the map.<br/>Each snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.<br/>The snapshotter generates the snapshot asynchronous.
34

‎scripts/templates/component.md.ejs

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<%
22
const component = locals.component;
33
-%>
4+
<!-- This file was autogenerated from <%- component.name %>.js do not modify -->
45
## <MapboxGL.<%- component.name %> />
56
### <%- replaceNewLine(component.description) %>
67

0 commit comments

Comments
 (0)