docs: cleanup modules docs

maplibre · Dec 21, 2024 · c20d39b · c20d39b
1 parent 149966d
commit c20d39b
Show file tree

Hide file tree

Showing 8 changed files with 1,112 additions and 1,146 deletions.
diff --git a/docs/docs.json b/docs/docs.json
diff --git a/docs/modules/offlineManager.md → docs/modules/OfflineManager.md b/docs/modules/offlineManager.md → docs/modules/OfflineManager.md
@@ -1,6 +1,6 @@
 <!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from src/modules/offline/OfflineManager.ts -->
-# `<offlineManager />`
+# `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/modules/snapshotManager.md → docs/modules/SnapshotManager.md b/docs/modules/snapshotManager.md → docs/modules/SnapshotManager.md
@@ -1,6 +1,6 @@
 <!-- DO NOT MODIFY -->
 <!-- This file is auto-generated from src/modules/snapshot/SnapshotManager.ts -->
-# `<snapshotManager />`
+# `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/docs/modules/coordinates.md b/docs/modules/coordinates.md
diff --git a/docs/modules/location.md b/docs/modules/location.md
diff --git a/scripts/templates/component.md.ejs b/scripts/templates/component.md.ejs
@@ -4,7 +4,7 @@
 -%>
 <!-- <%= helpers.autoGeneratedHeader.doNotModify %> -->
 <!-- <%= helpers.autoGeneratedHeader.generatedFrom(component.filePath) %> -->
-# `<<%- component.name %> />`
+# `<%- component.type === "component" ? `<${component.name} />` : component.name %>`
 <%- helpers.replaceNewLine(component.description) %>
 
 <%_ if (component.props && component.props.length) { _%>

diff --git a/scripts/utils/DocJSONBuilder.ts b/scripts/utils/DocJSONBuilder.ts
@@ -414,9 +414,7 @@ export class DocJSONBuilder {
           const modules = JSON.parse(stdout);
           for (const module of modules) {
             const node = new JSDocNodeTree(module);
-            const name = `${module.name
-              .charAt(0)
-              .toLowerCase()}${module.name.substring(1)}`;
+            const name = module.name;
 
             results[name] = {
               name,

diff --git a/src/modules/location/LocationManager.ts b/src/modules/location/LocationManager.ts
@@ -11,53 +11,53 @@ export const LocationModuleEventEmitter = new NativeEventEmitter(
   MLRNLocationModule,
 );
 
-/**
+/*
  * Location sent by LocationManager
  */
 export interface Location {
   coords: Coordinates;
   timestamp?: number;
 }
 
-/**
- * Coorinates sent by LocationManager
+/*
+ * Coordinates sent by LocationManager
  */
 interface Coordinates {
-  /**
+  /*
    * The heading (measured in degrees) relative to true north.
    * Heading is used to describe the direction the device is pointing to (the value of the compass).
    * Note that on Android this is incorrectly reporting the course value as mentioned in issue https://github.com/rnmapbox/maps/issues/1213
    * and will be corrected in a future update.
    */
   heading?: number;
 
-  /**
+  /*
    * The direction in which the device is traveling, measured in degrees and relative to due north.
    * The course refers to the direction the device is actually moving (not the same as heading).
    */
   course?: number;
 
-  /**
+  /*
    * The instantaneous speed of the device, measured in meters per second.
    */
   speed?: number;
 
-  /**
+  /*
    * The latitude in degrees.
    */
   latitude: number;
 
-  /**
+  /*
    * The longitude in degrees.
    */
   longitude: number;
 
-  /**
+  /*
    * The radius of uncertainty for the location, measured in meters.
    */
   accuracy?: number;
 
-  /**
+  /*
    * The altitude, measured in meters.
    */
   altitude?: number;