Clean up doc comments

Author: hsubox76

common/api-review/app-check-exp.api.md

@@ -6,33 +6,36 @@
 
 import { FirebaseApp } from '@firebase/app-exp';
 
-// @public (undocumented)
+// @public
 export function activate(app: FirebaseApp, siteKeyOrProvider: string | AppCheckProvider, isTokenAutoRefreshEnabled?: boolean): void;
 
-// @public (undocumented)
-export type AppCheckComponentName = 'appCheck';
+// @public
+export interface AppCheck {
+    app: FirebaseApp;
+}
 
-// @public (undocumented)
+// @internal (undocumented)
+export type _AppCheckComponentName = 'app-check-exp';
+
+// Warning: (ae-internal-missing-underscore) The name "AppCheckInternalComponentName" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
 export type AppCheckInternalComponentName = 'app-check-internal';
 
-// @public (undocumented)
+// @public
 export interface AppCheckProvider {
     getToken(): Promise<AppCheckToken>;
 }
 
-// @public (undocumented)
+// @public
 export interface AppCheckToken {
     readonly expireTimeMillis: number;
     // (undocumented)
     readonly token: string;
 }
 
 // @public
-export interface FirebaseAppCheck {
-    activate(siteKeyOrProvider: string | AppCheckProvider, isTokenAutoRefreshEnabled?: boolean): void;
-    // (undocumented)
-    setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
-}
+export function getAppCheck(app?: FirebaseApp): AppCheck;
 
 // @public (undocumented)
 export function setTokenAutoRefreshEnabled(app: FirebaseApp, isTokenAutoRefreshEnabled: boolean): void;

packages-exp/app-check-exp/src/api.ts

@@ -96,10 +96,10 @@ export function activate(
   }
 }
 /**
- *
  * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
  * refreshes App Check tokens as needed. This overrides any value set
  * during `activate()`.
+ * @public
  */
 export function setTokenAutoRefreshEnabled(
   app: FirebaseApp,

packages-exp/app-check-exp/src/index.ts

@@ -16,20 +16,20 @@
  */
 import { registerVersion, _registerComponent } from '@firebase/app-exp';
 import { Component, ComponentType } from '@firebase/component';
-import { AppCheckComponentName } from './public-types';
+import { _AppCheckComponentName } from './public-types';
 import { factory, internalFactory } from './factory';
 import { initializeDebugMode } from './debug';
-import { AppCheckInternalComponentName } from './types';
+import { _AppCheckInternalComponentName } from './types';
 import { name, version } from '../package.json';
 
 // Used by other Firebase packages.
-export { AppCheckInternalComponentName };
+export { _AppCheckInternalComponentName as AppCheckInternalComponentName };
 
 export * from './api';
 export * from './public-types';
 
-const APP_CHECK_NAME: AppCheckComponentName = 'app-check-exp';
-const APP_CHECK_NAME_INTERNAL: AppCheckInternalComponentName =
+const APP_CHECK_NAME: _AppCheckComponentName = 'app-check-exp';
+const APP_CHECK_NAME_INTERNAL: _AppCheckInternalComponentName =
   'app-check-internal';
 function registerAppCheck(): void {
   // The public interface

packages-exp/app-check-exp/src/public-types.ts

@@ -29,13 +29,23 @@ export interface AppCheck {
   app: FirebaseApp;
 }
 
+/**
+ * An App Check provider. This can be either the built-in reCAPTCHA
+ * provider or a custom provider. For more on custom providers, see
+ * https://firebase.google.com/docs/app-check/web-custom-provider
+ * @public
+ */
 export interface AppCheckProvider {
   /**
-   * Returns an AppCheck token
+   * Returns an AppCheck token.
    */
   getToken(): Promise<AppCheckToken>;
 }
 
+/**
+ * The token returned from an {@link AppCheckProvider}.
+ * @public
+ */
 export interface AppCheckToken {
   readonly token: string;
   /**
@@ -44,4 +54,7 @@ export interface AppCheckToken {
   readonly expireTimeMillis: number;
 }
 
-export type AppCheckComponentName = 'app-check-exp';
+/**
+ * @internal
+ */
+export type _AppCheckComponentName = 'app-check-exp';

packages-exp/app-check-exp/src/types.ts

@@ -38,7 +38,10 @@ export interface AppCheckTokenResult {
   readonly error?: Error;
 }
 
-export type AppCheckInternalComponentName = 'app-check-internal';
+/**
+ * @internal
+ */
+export type _AppCheckInternalComponentName = 'app-check-internal';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {