Skip to content

Commit ae5d8b3

Browse files
committed
use remarks to separate method summary from rest of description
1 parent b989ff6 commit ae5d8b3

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

docs-devsite/ai.chromeadapter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ export interface ChromeAdapter
2424

2525
| Method | Description |
2626
| --- | --- |
27-
| [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) | Generates content using on-device inference.<!-- -->This is comparable to [GenerativeModel.generateContent()](./ai.generativemodel.md#generativemodelgeneratecontent) for generating content using in-cloud inference. |
28-
| [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) | Generates a content stream using on-device inference.<!-- -->This is comparable to [GenerativeModel.generateContentStream()](./ai.generativemodel.md#generativemodelgeneratecontentstream) for generating a content stream using in-cloud inference. |
27+
| [generateContent(request)](./ai.chromeadapter.md#chromeadaptergeneratecontent) | Generates content using on-device inference. |
28+
| [generateContentStream(request)](./ai.chromeadapter.md#chromeadaptergeneratecontentstream) | Generates a content stream using on-device inference. |
2929
| [isAvailable(request)](./ai.chromeadapter.md#chromeadapterisavailable) | Checks if the on-device model is capable of handling a given request. |
3030

3131
## ChromeAdapter.generateContent()

packages/ai/src/methods/chrome-adapter.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ export class ChromeAdapterImpl implements ChromeAdapter {
129129
/**
130130
* Generates content on device.
131131
*
132+
* @remarks
132133
* This is comparable to {@link GenerativeModel.generateContent} for generating content in
133134
* Cloud.
134135
* @param request - a standard Firebase AI {@link GenerateContentRequest}
@@ -149,6 +150,7 @@ export class ChromeAdapterImpl implements ChromeAdapter {
149150
/**
150151
* Generates content stream on device.
151152
*
153+
* @remarks
152154
* This is comparable to {@link GenerativeModel.generateContentStream} for generating content in
153155
* Cloud.
154156
* @param request - a standard Firebase AI {@link GenerateContentRequest}

packages/ai/src/types/chrome-adapter.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export interface ChromeAdapter {
3737
/**
3838
* Generates content using on-device inference.
3939
*
40+
* @remarks
4041
* This is comparable to {@link GenerativeModel.generateContent} for generating
4142
* content using in-cloud inference.
4243
* @param request - a standard Firebase AI {@link GenerateContentRequest}
@@ -46,6 +47,7 @@ export interface ChromeAdapter {
4647
/**
4748
* Generates a content stream using on-device inference.
4849
*
50+
* @remarks
4951
* This is comparable to {@link GenerativeModel.generateContentStream} for generating
5052
* a content stream using in-cloud inference.
5153
* @param request - a standard Firebase AI {@link GenerateContentRequest}

0 commit comments

Comments
 (0)