Use multi-line JSDoc comments for enum

Author: erikeldridge

common/api-review/vertexai.api.md

@@ -504,17 +504,13 @@ export interface ImagenSafetySettings {
 export interface HybridParams {
     mode?: InferenceMode;
     onCloudParams?: ModelParams;
-    // Warning: (ae-forgotten-export) The symbol "AILanguageModelCreateOptionsWithSystemPrompt" needs to be exported by the entry point index.d.ts
     onDeviceParams?: AILanguageModelCreateOptionsWithSystemPrompt;
 }
 
 // @public
 export enum InferenceMode {
-    // (undocumented)
     ONLY_ON_CLOUD = "ONLY_ON_CLOUD",
-    // (undocumented)
     ONLY_ON_DEVICE = "ONLY_ON_DEVICE",
-    // (undocumented)
     PREFER_ON_DEVICE = "PREFER_ON_DEVICE"
 }
 

packages/vertexai/src/types/enums.ts

@@ -246,10 +246,18 @@ export enum Modality {
  * @public
  */
 export enum InferenceMode {
-  // Specifies the SDK should use on-device if possible, or fall back to on-cloud.
+  /**
+   * Uses the on-device model if available, or falls back to the on-cloud model.
+   */
   PREFER_ON_DEVICE = 'PREFER_ON_DEVICE',
-  // Specifies the SDK must use on-device or throw.
+
+  /**
+   * Exclusively uses the on-device model. Throws if one is not available.
+   */
   ONLY_ON_DEVICE = 'ONLY_ON_DEVICE',
-  // Specifies the SDK must use on-cloud.
+
+  /**
+   * Exclusively uses the on-cloud model.
+   */
   ONLY_ON_CLOUD = 'ONLY_ON_CLOUD'
 }

packages/vertexai/src/types/requests.ts

@@ -225,7 +225,7 @@ export interface HybridParams {
    */
   mode?: InferenceMode;
   /**
-   * Optional. Specifies advanced params for on-device inference
+   * Optional. Specifies advanced params for on-device inference.
    */
   onDeviceParams?: AILanguageModelCreateOptionsWithSystemPrompt;
   /**