diff --git a/etc/firebase-admin.api.md b/etc/firebase-admin.api.md index df6558951e..7ec4aaff22 100644 --- 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 index 1614e2acb3..794a74e9e4 100644 --- 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 index 8e45cf81f9..4241e2ecf7 100644 --- 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 index 12ecdd6008..abc6b75a0c 100644 --- 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 index 7d83ee108a..392d55a71c 100644 --- 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 index 81528b204c..0754a74e69 100644 --- 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 index 70b0b778ab..149a81c61a 100644 --- 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 index 9b6416aa0d..a7ac9f1182 100644 --- 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 index 4b69129073..a2d20dc539 100644 --- 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 index d85e53d66f..6e0e2eb142 100644 --- 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 index 9fb95e3493..c3a75dd97e 100644 --- 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 index b0b7199eb7..278148d2b2 100644 --- 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 index e343e4fac2..02a8509653 100644 --- 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 index 272762f0b5..afbbe780ca 100644 --- 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 index f5b71fb7c3..57e9264f4e 100644 --- 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 index 22ea79d419..5405cc67c6 100644 --- 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 index 3d91bf9486..bc52480a44 100644 --- 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 index fdc44e8341..40043b9467 100644 --- 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 index e10fb222ac..a3bf1d8f8a 100644 --- 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 index 9d4cb990ae..233bf98988 100644 --- 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 index 92dd34f449..1bdff385f9 100644 --- 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 index 24c8a1fa4e..ae7eaaad45 100644 --- 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 index 11770d381d..0f8c846b7e 100644 --- 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 index 878174afa2..bbab751584 100644 --- 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';