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

hiranya911 · web-flow · commit 70d830bf46c4 · 2021-05-25T09:48:45.000-07:00
diff --git a/etc/firebase-admin.api.md b/etc/firebase-admin.api.md
@@ -457,6 +457,4 @@ export namespace storage {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.app.api.md b/etc/firebase-admin.app.api.md
@@ -85,6 +85,4 @@ export interface ServiceAccount {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.auth.api.md b/etc/firebase-admin.auth.api.md
@@ -454,6 +454,4 @@ export class UserRecord {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.database.api.md b/etc/firebase-admin.database.api.md
@@ -48,6 +48,4 @@ export const ServerValue: rtdb.ServerValue;
 export { ThenableReference }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.firestore.api.md b/etc/firebase-admin.firestore.api.md
@@ -96,6 +96,4 @@ export { WriteBatch }
 export { WriteResult }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.instance-id.api.md b/etc/firebase-admin.instance-id.api.md
@@ -18,6 +18,4 @@ export class InstanceId {
     }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.machine-learning.api.md b/etc/firebase-admin.machine-learning.api.md
@@ -90,6 +90,4 @@ export interface TFLiteModel {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.messaging.api.md b/etc/firebase-admin.messaging.api.md
@@ -351,6 +351,4 @@ export interface WebpushNotification {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.project-management.api.md b/etc/firebase-admin.project-management.api.md
@@ -87,6 +87,4 @@ export class ShaCertificate {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.remote-config.api.md b/etc/firebase-admin.remote-config.api.md
@@ -114,6 +114,4 @@ export interface Version {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.security-rules.api.md b/etc/firebase-admin.security-rules.api.md
@@ -57,6 +57,4 @@ export class SecurityRules {
 }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/etc/firebase-admin.storage.api.md b/etc/firebase-admin.storage.api.md
@@ -19,6 +19,4 @@ export class Storage {
     }
 
 
-// (No @packageDocumentation comment for this package)
-
 ```
diff --git a/src/app/index.ts b/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';
 
diff --git a/src/auth/index.ts b/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';
diff --git a/src/database/index.ts b/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,
diff --git a/src/default-namespace.d.ts b/src/default-namespace.d.ts
@@ -14,4 +14,10 @@
  * limitations under the License.
  */
 
+/**
+ * Firebase namespaced API (legacy).
+ *
+ * @packageDocumentation
+ */
+
 export * from './firebase-namespace-api';
diff --git a/src/firestore/index.ts b/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';
diff --git a/src/instance-id/index.ts b/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 };
 
diff --git a/src/machine-learning/index.ts b/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';
diff --git a/src/messaging/index.ts b/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';
diff --git a/src/project-management/index.ts b/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';
diff --git a/src/remote-config/index.ts b/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';
diff --git a/src/security-rules/index.ts b/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';
diff --git a/src/storage/index.ts b/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';

Original file line number	Diff line number	Diff line change
`@@ -457,6 +457,4 @@ export namespace storage {`
`457`	`457`	`}`
`458`	`458`
`459`	`459`
`460`		`-// (No @packageDocumentation comment for this package)`
`461`		`-`
`462`	`460`	```
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,4 @@ export interface ServiceAccount {`
`85`	`85`	`}`
`86`	`86`
`87`	`87`
`88`		`-// (No @packageDocumentation comment for this package)`
`89`		`-`
`90`	`88`	```
Original file line number	Diff line number	Diff line change
`@@ -454,6 +454,4 @@ export class UserRecord {`
`454`	`454`	`}`
`455`	`455`
`456`	`456`
`457`		`-// (No @packageDocumentation comment for this package)`
`458`		`-`
`459`	`457`	```
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,4 @@ export class InstanceId {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`
`21`		`-// (No @packageDocumentation comment for this package)`
`22`		`-`
`23`	`21`	```
Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,4 @@ export interface TFLiteModel {`
`90`	`90`	`}`
`91`	`91`
`92`	`92`
`93`		`-// (No @packageDocumentation comment for this package)`
`94`		`-`
`95`	`93`	```
Original file line number	Diff line number	Diff line change
`@@ -351,6 +351,4 @@ export interface WebpushNotification {`
`351`	`351`	`}`
`352`	`352`
`353`	`353`
`354`		`-// (No @packageDocumentation comment for this package)`
`355`		`-`
`356`	`354`	```
Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,4 @@ export class ShaCertificate {`
`87`	`87`	`}`
`88`	`88`
`89`	`89`
`90`		`-// (No @packageDocumentation comment for this package)`
`91`		`-`
`92`	`90`	```
Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,4 @@ export interface Version {`
`114`	`114`	`}`
`115`	`115`
`116`	`116`
`117`		`-// (No @packageDocumentation comment for this package)`
`118`		`-`
`119`	`117`	```