Skip to content

Commit bef344b

Browse files
fix: add descriptive comments to API members
Changed comments for `secrets` property in various files from `/*` to `/**` to ensure they are picked up by documentation generators. Also updated `Expression` class comment in `src/params/types.ts` to be a JSDoc comment. Co-authored-by: egilmorez <5544707+egilmorez@users.noreply.github.com>
1 parent 3651736 commit bef344b

File tree

11 files changed

+11
-11
lines changed

11 files changed

+11
-11
lines changed

src/params/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import * as logger from "../logger";
2424

2525
const EXPRESSION_TAG = Symbol.for("firebase-functions:Expression:Tag");
2626

27-
/*
27+
/**
2828
* A CEL expression which can be evaluated during function deployment, and
2929
* resolved to a value of the generic type parameter: i.e, you can pass
3030
* an Expression<number> as the value of an option that normally accepts numbers.

src/v1/function-configuration.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ export interface RuntimeOptions {
232232
*/
233233
invoker?: "public" | "private" | string | string[];
234234

235-
/*
235+
/**
236236
* Secrets to bind to a function instance.
237237
*/
238238
secrets?: SupportedSecretParam[];

src/v2/options.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ export interface GlobalOptions {
207207
*/
208208
labels?: Record<string, string>;
209209

210-
/*
210+
/**
211211
* Secrets to bind to a function.
212212
*/
213213
secrets?: SupportedSecretParam[];

src/v2/providers/alerts/alerts.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
177177
*/
178178
labels?: Record<string, string>;
179179

180-
/*
180+
/**
181181
* Secrets to bind to a function.
182182
*/
183183
secrets?: SupportedSecretParam[];

src/v2/providers/database.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
189189
*/
190190
labels?: Record<string, string>;
191191

192-
/*
192+
/**
193193
* Secrets to bind to a function.
194194
*/
195195
secrets?: SupportedSecretParam[];

src/v2/providers/eventarc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
153153
*/
154154
labels?: Record<string, string>;
155155

156-
/*
156+
/**
157157
* Secrets to bind to a function.
158158
*/
159159
secrets?: SupportedSecretParam[];

src/v2/providers/https.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region" | "enforceApp
162162
*/
163163
labels?: Record<string, string>;
164164

165-
/*
165+
/**
166166
* Secrets to bind to a function.
167167
*/
168168
secrets?: SupportedSecretParam[];

src/v2/providers/identity.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ export interface BlockingOptions {
160160
*/
161161
labels?: Record<string, string>;
162162

163-
/*
163+
/**
164164
* Secrets to bind to a function.
165165
*/
166166
secrets?: SupportedSecretParam[];

src/v2/providers/pubsub.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ export interface PubSubOptions extends options.EventHandlerOptions {
278278
*/
279279
labels?: Record<string, string>;
280280

281-
/*
281+
/**
282282
* Secrets to bind to a function.
283283
*/
284284
secrets?: SupportedSecretParam[];

src/v2/providers/storage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ export interface StorageOptions extends options.EventHandlerOptions {
294294
*/
295295
labels?: Record<string, string>;
296296

297-
/*
297+
/**
298298
* Secrets to bind to a function.
299299
*/
300300
secrets?: SupportedSecretParam[];

0 commit comments

Comments
 (0)