Skip to content

docs: stop docgen from linking parts of code spans #367

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
robingenz merged 1 commit into from
Nov 5, 2026
Merged

docs: stop docgen from linking parts of code spans #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 packages/face-mesh-detection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ When `BoundingBoxOnly` is selected, <a href="#facemesh">`FaceMesh`</a> only cont

When <a href="#facemesh">`FaceMesh`</a> is selected, <a href="#facemesh">`FaceMesh`</a> also contains a group of 468 3D face mesh points and related triangle information.
Each point is represented by <a href="#facemeshpoint">`FaceMeshPoint`</a> describing a specific position in detected face.
The triangle information is a group of 3 `FaceMeshPoint`s representing a valid surface on Face (e.g. a valid small surface on nose tip).
The triangle information is a group of 3 <a href="#facemeshpoint">`FaceMeshPoint`</a>s representing a valid surface on Face (e.g. a valid small surface on nose tip).

| Prop | Type | Description | Since |
| -------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
Expand Down
8 changes: 4 additions & 4 deletions packages/genai-summarization/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,10 +356,10 @@ output type and language. Therefore, `checkFeatureStatus(...)` and

#### InputType

| Members | Value | Description | Since |
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------------------- | ----- |
| **`Article`** | <code>'ARTICLE'</code> | The input text is an article. | 8.2.0 |
| **`Conversation`** | <code>'CONVERSATION'</code> | The input text is a conversation where each line uses the format `&lt;name&gt;: &lt;message&gt;`. | 8.2.0 |
| Members | Value | Description | Since |
| ------------------ | --------------------------- | ------------------------------------------------------------------------------------- | ----- |
| **`Article`** | <code>'ARTICLE'</code> | The input text is an article. | 8.2.0 |
| **`Conversation`** | <code>'CONVERSATION'</code> | The input text is a conversation where each line uses the format `<name>: <message>`. | 8.2.0 |


#### Language
Expand Down
10 changes: 5 additions & 5 deletions packages/translation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,11 +272,11 @@ Only available on Android and iOS.

#### TranslateOptions

| Prop | Type | Description | Since |
| -------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **`text`** | <code>string</code> | The text to translate. | 0.0.1 |
| **`sourceLanguage`** | <code><a href="#language">Language</a></code> | The source language of the text. If you don't know the source language, you can use the <a href="#language">`Language</a> Identification` plugin to detect it. | 0.0.1 |
| **`targetLanguage`** | <code><a href="#language">Language</a></code> | The target language to translate the text to. | 0.0.1 |
| Prop | Type | Description | Since |
| -------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **`text`** | <code>string</code> | The text to translate. | 0.0.1 |
| **`sourceLanguage`** | <code><a href="#language">Language</a></code> | The source language of the text. If you don't know the source language, you can use the `Language Identification` plugin to detect it. | 0.0.1 |
| **`targetLanguage`** | <code><a href="#language">Language</a></code> | The target language to translate the text to. | 0.0.1 |


### Enums
Expand Down
20 changes: 20 additions & 0 deletions patches/@capacitor+docgen+0.3.1.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
diff --git a/node_modules/@capacitor/docgen/dist/formatting.js b/node_modules/@capacitor/docgen/dist/formatting.js
--- a/node_modules/@capacitor/docgen/dist/formatting.js
+++ b/node_modules/@capacitor/docgen/dist/formatting.js
@@ -5,8 +5,15 @@
if (typeof c !== 'string') {
return '';
}
- return formatTokens(data, tokenize(c));
+ return c
+ .split(/(`[^`]*`)/)
+ .map((part, index) => (index % 2 === 1 ? formatCodeSpan(data, part) : formatTokens(data, tokenize(part))))
+ .join('');
}
+// Link a code span only if it names a plugin type as a whole, so that native names like `BillingClient.ProductType.INAPP` stay plain.
+function formatCodeSpan(data, codeSpan) {
+ return linkToken(data, codeSpan) || codeSpan;
+}
exports.formatDescription = formatDescription;
function formatType(data, c) {
c = cleanWhitespace(String(c));
diff --git a/node_modules/@capacitor/docgen/dist/parse.js b/node_modules/@capacitor/docgen/dist/parse.js
index 8e863fb..38d9d99 100644
--- a/node_modules/@capacitor/docgen/dist/parse.js
Expand Down
Loading