chore: Added package docs for module entry points (#1275)

Author: hiranya911

etc/firebase-admin.api.md

@@ -457,6 +457,4 @@ export namespace storage {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.app.api.md

@@ -85,6 +85,4 @@ export interface ServiceAccount {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.auth.api.md

@@ -454,6 +454,4 @@ export class UserRecord {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.database.api.md

@@ -48,6 +48,4 @@ export const ServerValue: rtdb.ServerValue;
 export { ThenableReference }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.firestore.api.md

@@ -96,6 +96,4 @@ export { WriteBatch }
 export { WriteResult }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.instance-id.api.md

@@ -18,6 +18,4 @@ export class InstanceId {
     }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.machine-learning.api.md

@@ -90,6 +90,4 @@ export interface TFLiteModel {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.messaging.api.md

@@ -351,6 +351,4 @@ export interface WebpushNotification {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.project-management.api.md

@@ -87,6 +87,4 @@ export class ShaCertificate {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.remote-config.api.md

@@ -114,6 +114,4 @@ export interface Version {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.security-rules.api.md

@@ -57,6 +57,4 @@ export class SecurityRules {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

etc/firebase-admin.storage.api.md

@@ -19,6 +19,4 @@ export class Storage {
     }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```

src/app/index.ts

@@ -17,6 +17,12 @@
 
 import { getSdkVersion } from '../utils';
 
+/**
+ * Firebase App and SDK initialization.
+ *
+ * @packageDocumentation
+ */
+
 export { App, AppOptions, FirebaseArrayIndexError, FirebaseError } from './core'
 export { initializeApp, getApp, getApps, deleteApp } from './lifecycle';
 

src/auth/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase Authentication.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app/index';
 import { FirebaseApp } from '../app/firebase-app';
 import { Auth } from './auth';

src/database/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase Realtime Database.
+ *
+ * @packageDocumentation
+ */
+
 import * as rtdb from '@firebase/database-types';
 import {
   enableLogging as enableLoggingFunc,

src/default-namespace.d.ts

@@ -14,4 +14,10 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase namespaced API (legacy).
+ *
+ * @packageDocumentation
+ */
+
 export * from './firebase-namespace-api';

src/firestore/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Cloud Firestore.
+ *
+ * @packageDocumentation
+ */
+
 import { Firestore } from '@google-cloud/firestore';
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';

src/instance-id/index.ts

@@ -14,9 +14,15 @@
  * limitations under the License.
  */
 
-import { FirebaseApp } from '../app/firebase-app';
+/**
+ * Firebase Instance ID service.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app/index';
 import { InstanceId } from './instance-id';
+import { FirebaseApp } from '../app/firebase-app';
 
 export { InstanceId };
 

src/machine-learning/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase Machine Learning.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import { MachineLearning } from './machine-learning';

src/messaging/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase Cloud Messaging (FCM).
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import { Messaging } from './messaging';

src/project-management/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase project management.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import { ProjectManagement } from './project-management';

src/remote-config/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase Remote Config.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import { RemoteConfig } from './remote-config';

src/security-rules/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Security Rules for Cloud Firestore and Cloud Storage.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import { SecurityRules } from './security-rules';

src/storage/index.ts

@@ -14,6 +14,12 @@
  * limitations under the License.
  */
 
+/**
+ * Cloud Storage for Firebase.
+ *
+ * @packageDocumentation
+ */
+
 import { App, getApp } from '../app';
 import { FirebaseApp } from '../app/firebase-app';
 import { Storage } from './storage';