Add autogenerated warning to generated docs (maplibre#478)

airteamaus · Oct 20, 2019 · 523ad3b · 523ad3b
1 parent 94d831a
commit 523ad3b
Show file tree

Hide file tree

Showing 23 changed files with 23 additions and 0 deletions.
diff --git a/docs/Annotation.md b/docs/Annotation.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from Annotation.js do not modify -->
 ## <MapboxGL.Annotation />
 ### 
 

diff --git a/docs/BackgroundLayer.md b/docs/BackgroundLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from BackgroundLayer.js do not modify -->
 ## <MapboxGL.BackgroundLayer />
 ### 
 

diff --git a/docs/Callout.md b/docs/Callout.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from Callout.js do not modify -->
 ## <MapboxGL.Callout />
 ### Callout that displays information about a selected annotation near the annotation.
 

diff --git a/docs/Camera.md b/docs/Camera.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from Camera.js do not modify -->
 ## <MapboxGL.Camera />
 ### 
 

diff --git a/docs/CircleLayer.md b/docs/CircleLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from CircleLayer.js do not modify -->
 ## <MapboxGL.CircleLayer />
 ### CircleLayer is a style layer that renders one or more filled circles on the map.
 

diff --git a/docs/FillExtrusionLayer.md b/docs/FillExtrusionLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from FillExtrusionLayer.js do not modify -->
 ## <MapboxGL.FillExtrusionLayer />
 ### FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.
 

diff --git a/docs/FillLayer.md b/docs/FillLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from FillLayer.js do not modify -->
 ## <MapboxGL.FillLayer />
 ### FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.
 

diff --git a/docs/HeatmapLayer.md b/docs/HeatmapLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from HeatmapLayer.js do not modify -->
 ## <MapboxGL.HeatmapLayer />
 ### HeatmapLayer is a style layer that renders one or more filled circles on the map.
 

diff --git a/docs/ImageSource.md b/docs/ImageSource.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from ImageSource.js do not modify -->
 ## <MapboxGL.ImageSource />
 ### 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
 

diff --git a/docs/Images.md b/docs/Images.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from Images.js do not modify -->
 ## <MapboxGL.Images />
 ### Images defines the images used in Symbol etc layers
 

diff --git a/docs/Light.md b/docs/Light.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from Light.js do not modify -->
 ## <MapboxGL.Light />
 ### Light represents the light source for extruded geometries
 

diff --git a/docs/LineLayer.md b/docs/LineLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from LineLayer.js do not modify -->
 ## <MapboxGL.LineLayer />
 ### LineLayer is a style layer that renders one or more stroked polylines on the map.
 

diff --git a/docs/MapView.md b/docs/MapView.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from MapView.js do not modify -->
 ## <MapboxGL.MapView />
 ### MapView backed by Mapbox Native GL
 

diff --git a/docs/OfflineManager.md b/docs/OfflineManager.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from offlineManager.js do not modify -->
 ## <MapboxGL.offlineManager />
 ### 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.
 

diff --git a/docs/PointAnnotation.md b/docs/PointAnnotation.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from PointAnnotation.js do not modify -->
 ## <MapboxGL.PointAnnotation />
 ### 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.
 

diff --git a/docs/RasterLayer.md b/docs/RasterLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from RasterLayer.js do not modify -->
 ## <MapboxGL.RasterLayer />
 ### 
 

diff --git a/docs/RasterSource.md b/docs/RasterSource.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from RasterSource.js do not modify -->
 ## <MapboxGL.RasterSource />
 ### 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.
 

diff --git a/docs/ShapeSource.md b/docs/ShapeSource.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from ShapeSource.js do not modify -->
 ## <MapboxGL.ShapeSource />
 ### 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
 

diff --git a/docs/SymbolLayer.md b/docs/SymbolLayer.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from SymbolLayer.js do not modify -->
 ## <MapboxGL.SymbolLayer />
 ### SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.
 

diff --git a/docs/UserLocation.md b/docs/UserLocation.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from UserLocation.js do not modify -->
 ## <MapboxGL.UserLocation />
 ### 
 

diff --git a/docs/VectorSource.md b/docs/VectorSource.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from VectorSource.js do not modify -->
 ## <MapboxGL.VectorSource />
 ### 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.
 

diff --git a/docs/snapshotManager.md b/docs/snapshotManager.md
@@ -1,3 +1,4 @@
+<!-- This file was autogenerated from snapshotManager.js do not modify -->
 ## <MapboxGL.snapshotManager />
 ### 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.
 

diff --git a/scripts/templates/component.md.ejs b/scripts/templates/component.md.ejs
@@ -1,6 +1,7 @@
 <%
   const component = locals.component;
 -%>
+<!-- This file was autogenerated from <%- component.name %>.js do not modify -->
 ## <MapboxGL.<%- component.name %> />
 ### <%- replaceNewLine(component.description) %>