Skip to content

Fix doc comments #8234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 8, 2024
Merged

Fix doc comments #8234

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4002c0
fix doc comments
hsubox76 May 8, 2024
2d88c22
fix one more comment
hsubox76 May 8, 2024
486e000
Update docs-devsite/vertexai-preview.md
hsubox76 May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-devsite/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Firebase Vertex Web SDK. |
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI For Firebase Web SDK. |

8 changes: 4 additions & 4 deletions docs-devsite/vertexai-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# vertexai-preview package
The Firebase Vertex Web SDK.
The Vertex AI For Firebase Web SDK.

## Functions

| Function | Description |
| --- | --- |
| <b>function(app, ...)</b> |
| [getVertexAI(app, options)](./vertexai-preview.md#getvertexai_04094cf) | Returns an [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app. |
| [getVertexAI(app, options)](./vertexai-preview.md#getvertexai_04094cf) | Returns a [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app. |
| <b>function(vertexAI, ...)</b> |
| [getGenerativeModel(vertexAI, modelParams, requestOptions)](./vertexai-preview.md#getgenerativemodel_e3037c9) | Returns a [GenerativeModel](./vertexai-preview.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |

Expand Down Expand Up @@ -87,7 +87,7 @@ The Firebase Vertex Web SDK.
| [ToolConfig](./vertexai-preview.toolconfig.md#toolconfig_interface) | Tool config. This config is shared for all tools provided in the request. |
| [UsageMetadata](./vertexai-preview.usagemetadata.md#usagemetadata_interface) | Usage metadata about a [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->. |
| [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) | An instance of the Vertex AI for Firebase SDK. |
| [VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the Firebase Vertex AI SDK. |
| [VertexAIOptions](./vertexai-preview.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the VertexAI for Firebase SDK. |
| [VideoMetadata](./vertexai-preview.videometadata.md#videometadata_interface) | Describes the input video content. |
| [WebAttribution](./vertexai-preview.webattribution.md#webattribution_interface) | |

Expand All @@ -109,7 +109,7 @@ The Firebase Vertex Web SDK.

### getVertexAI(app, options) {:#getvertexai_04094cf}

Returns an [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app.
Returns a [VertexAI](./vertexai-preview.vertexai.md#vertexai_interface) instance for the given app.

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/vertexai-preview.vertexaioptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# VertexAIOptions interface
Options when initializing the Firebase Vertex AI SDK.
Options when initializing the Vertex AI for Firebase SDK.

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion packages/vertexai/src/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ declare module '@firebase/component' {
}

/**
* Returns an {@link VertexAI} instance for the given app.
* Returns a {@link VertexAI} instance for the given app.
*
* @public
*
Expand Down
2 changes: 1 addition & 1 deletion packages/vertexai/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* The Firebase Vertex Web SDK.
* The Vertex AI For Firebase Web SDK.
*
* @packageDocumentation
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/vertexai/src/public-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface VertexAI {
}

/**
* Options when initializing the Firebase Vertex AI SDK.
* Options when initializing the Vertex AI for Firebase SDK.
* @public
*/
export interface VertexAIOptions {
Expand Down
Loading