add documentations to public apis

Author: ChaoqunCHEN

common/api-review/installations-exp.api.md

@@ -7,22 +7,22 @@
 import { FirebaseApp } from '@firebase/app-types-exp';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
-// @public (undocumented)
+// @public
 export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;
 
-// @public (undocumented)
+// @public
 export function getId(installations: FirebaseInstallations): Promise<string>;
 
-// @public (undocumented)
+// @public
 export function getInstallations(app: FirebaseApp): FirebaseInstallations;
 
-// @public (undocumented)
+// @public
 export function getToken(installations: FirebaseInstallations, forceRefresh?: boolean): Promise<string>;
 
-// @public (undocumented)
+// @public
 export type IdChangeCallbackFn = (installationId: string) => void;
 
-// @public (undocumented)
+// @public
 export type IdChangeUnsubscribeFn = () => void;
 
 // @public

packages-exp/installations-exp/src/api/delete-installations.ts

@@ -23,6 +23,8 @@ import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * Deletes the Firebase Installation and all associated data.
+ *
  * @public
  */
 export async function deleteInstallations(

packages-exp/installations-exp/src/api/get-id.ts

@@ -21,6 +21,9 @@ import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * Creates a Firebase Installation if there isn't one for the app and
+ * returns the Installation ID.
+ *
  * @public
  */
 export async function getId(

packages-exp/installations-exp/src/api/get-installations.ts

@@ -20,6 +20,8 @@ import { FirebaseInstallations } from '@firebase/installations-types-exp';
 import { _getProvider } from '@firebase/app-exp';
 
 /**
+ * Returns a Firebase Installation instance for the given app.
+ *
  * @public
  */
 export function getInstallations(app: FirebaseApp): FirebaseInstallations {

packages-exp/installations-exp/src/api/get-token.ts

@@ -24,6 +24,9 @@ import {
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ *
+ * Returns an authentication token for the current Firebase Installation.
+ *
  * @public
  */
 export async function getToken(

packages-exp/installations-exp/src/api/on-id-change.ts

@@ -20,10 +20,14 @@ import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
 import { FirebaseInstallations } from '@firebase/installations-types-exp';
 
 /**
+ * An user defined callback function that takes action when Installations ID changes.
+ *
  * @public
  */
 export type IdChangeCallbackFn = (installationId: string) => void;
 /**
+ * An unsubscribe function that will remove the onIdChange callback when called.
+ *
  * @public
  */
 export type IdChangeUnsubscribeFn = () => void;

packages-exp/installations-types-exp/index.d.ts

@@ -16,6 +16,8 @@
  */
 
 /**
+ * A Firebase Installation instance which is a required argument for all Firebase Installations operations.
+ *
  * @public
  */
 export interface FirebaseInstallations {}