docs: cleanup (#493)

* chore: remove misplaced file * chore: remove unused template * docs: add unified auto generated header * docs: run codegen
maplibre · Nov 18, 2024 · cab6e95 · cab6e95
1 parent 238af62
commit cab6e95
Show file tree

Hide file tree

Showing 44 changed files with 70 additions and 1,325 deletions.
diff --git a/android/src/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFactory.java b/android/src/main/java/com/maplibre/rctmln/components/styles/RCTMLNStyleFactory.java
@@ -1,5 +1,5 @@
 // DO NOT MODIFY
-// THIS FILE IS AUTOGENERATED
+// This file is auto-generated from scripts/templates/RCTMLNStyleFactory.java.ejs
 
 package com.maplibre.rctmln.components.styles;
 

diff --git a/docs/Annotation.md b/docs/Annotation.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/Annotation.tsx -->
 # `<MapLibreGL.Annotation />`
 

diff --git a/docs/BackgroundLayer.md b/docs/BackgroundLayer.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/BackgroundLayer.tsx -->
 # `<MapLibreGL.BackgroundLayer />`
 

diff --git a/docs/Callout.md b/docs/Callout.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/Callout.tsx -->
 # `<MapLibreGL.Callout />`
 Callout that displays information about a selected annotation near the annotation.

diff --git a/docs/Camera.md b/docs/Camera.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/Camera.tsx -->
 # `<MapLibreGL.Camera />`
 

diff --git a/docs/CircleLayer.md b/docs/CircleLayer.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/CircleLayer.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/FillExtrusionLayer.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/FillLayer.tsx -->
 # `<MapLibreGL.FillLayer />`
 FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.

diff --git a/docs/HeadingIndicator.md b/docs/HeadingIndicator.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/HeadingIndicator.tsx -->
 # `<MapLibreGL.HeadingIndicator />`
 

diff --git a/docs/HeatmapLayer.md b/docs/HeatmapLayer.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/HeatmapLayer.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/ImageSource.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/Images.tsx -->
 # `<MapLibreGL.Images />`
 Images defines the images used in Symbol etc layers

diff --git a/docs/Light.md b/docs/Light.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/Light.tsx -->
 # `<MapLibreGL.Light />`
 Light represents the light source for extruded geometries

diff --git a/docs/LineLayer.md b/docs/LineLayer.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/LineLayer.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/MapView.tsx -->
 # `<MapLibreGL.MapView />`
 MapView backed by MapLibre Native

diff --git a/docs/MarkerView.md b/docs/MarkerView.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/MarkerView.tsx -->
 # `<MapLibreGL.MarkerView />`
 MarkerView allows you to place a interactive react native marker to the map.<br/><br/>If you have static view consider using PointAnnotation or SymbolLayer they'll offer much better performance<br/>.<br/>This is based on [MakerView plugin](https://docs.mapbox.com/android/plugins/overview/markerview/) on Android<br/>and PointAnnotation on iOS.

diff --git a/docs/NativeUserLocation.md b/docs/NativeUserLocation.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/NativeUserLocation.tsx -->
 # `<MapLibreGL.NativeUserLocation />`
 

diff --git a/docs/PointAnnotation.md b/docs/PointAnnotation.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/PointAnnotation.tsx -->
 # `<MapLibreGL.PointAnnotation />`
 PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.<br/><br/>Consider using ShapeSource and SymbolLayer instead, if you have many points and you have static images,<br/>they'll offer much better performance<br/><br/>.<br/>If you need interctive views please use MarkerView,<br/>as with PointAnnotation on Android child views are rendered onto a bitmap for better performance.

diff --git a/docs/RasterLayer.md b/docs/RasterLayer.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/RasterLayer.tsx -->
 # `<MapLibreGL.RasterLayer />`
 

diff --git a/docs/RasterSource.md b/docs/RasterSource.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/RasterSource.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/ShapeSource.tsx -->
 # `<MapLibreGL.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/Style.md b/docs/Style.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/Style.tsx -->
 # `<MapLibreGL.Style />`
 Style is a component that automatically adds sources / layers to the map using MapLibre Style Spec.<br/>Only [`sources`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/) & [`layers`](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/) are supported.<br/>Other fields such as `sprites`, `glyphs` etc. will be ignored. Not all layer / source attributes from the style spec are supported, in general the supported attributes will be mentioned under https://github.com/maplibre/maplibre-react-native/tree/main/docs.<br/><br/>TODO: Maintainer forking this project does not understand the above comment regarding what is supported.

diff --git a/docs/SymbolLayer.md b/docs/SymbolLayer.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/SymbolLayer.tsx -->
 # `<MapLibreGL.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,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/UserLocation.tsx -->
 # `<MapLibreGL.UserLocation />`
 

diff --git a/docs/VectorSource.md b/docs/VectorSource.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/components/VectorSource.tsx -->
 # `<MapLibreGL.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/coordinates.md b/docs/coordinates.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/modules/location/locationManager.ts -->
 # `<MapLibreGL.coordinates />`
 Coorinates sent by locationManager

diff --git a/docs/location.md b/docs/location.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/modules/location/locationManager.ts -->
 # `<MapLibreGL.location />`
 Location sent by locationManager

diff --git a/docs/offlineManager.md b/docs/offlineManager.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/modules/offline/offlineManager.ts -->
 # `<MapLibreGL.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/snapshotManager.md b/docs/snapshotManager.md
@@ -1,4 +1,4 @@
-<!-- DO NOT MODIFY! -->
+<!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from javascript/modules/snapshot/snapshotManager.ts -->
 # `<MapLibreGL.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/ios/RCTMLN/RCTMLNStyle.h b/ios/RCTMLN/RCTMLNStyle.h
@@ -1,5 +1,5 @@
 // DO NOT MODIFY
-// THIS FILE IS AUTOGENERATED
+// This file is auto-generated from scripts/templates/RCTMLNStyle.h.ejs
 
 #import "RCTMLNStyle.h"
 #import "RCTMLNStyleValue.h"

diff --git a/ios/RCTMLN/RCTMLNStyle.m b/ios/RCTMLN/RCTMLNStyle.m
@@ -1,5 +1,5 @@
 // DO NOT MODIFY
-// THIS FILE IS AUTOGENERATED
+// This file is auto-generated from scripts/templates/RCTMLNStyle.m.ejs
 
 #import "RCTMLNStyle.h"
 #import "RCTMLNUtils.h"