CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-07 00:50:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: update api-documenter and apply new patch (#7075)

Browse Source
This commit is contained in:
Maribeth Bottorff
2023-05-11 15:39:08 -07:00
committed by GitHub
parent de904ab128
commit 68eb38889a
3 changed files with 52 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
patches/@microsoft+api-documenter+7.19.24.patch → patches/@microsoft+api-documenter+7.22.4.patch
View File

@@ -1,8 +1,8 @@
diff --git a/node_modules/@microsoft/api-documenter/lib/documenters/MarkdownDocumenter.js b/node_modules/@microsoft/api-documenter/lib/documenters/MarkdownDocumenter.js
index 421f89f..b9d329b 100644
index 5284d10..f2f9d14 100644
--- a/node_modules/@microsoft/api-documenter/lib/documenters/MarkdownDocumenter.js
+++ b/node_modules/@microsoft/api-documenter/lib/documenters/MarkdownDocumenter.js
@@ -856,12 +856,15 @@ class MarkdownDocumenter {
@@ -877,12 +877,15 @@ class MarkdownDocumenter {
}
_writeBreadcrumb(output, apiItem) {
const configuration = this._tsdocConfiguration;
@@ -24,7 +24,7 @@ index 421f89f..b9d329b 100644
for (const hierarchyItem of apiItem.getHierarchy()) {
switch (hierarchyItem.kind) {
case api_extractor_model_1.ApiItemKind.Model:
@@ -871,18 +874,24 @@ class MarkdownDocumenter {
@@ -892,18 +895,24 @@ class MarkdownDocumenter {
// this may change in the future.
break;
default:
@@ -33,10 +33,10 @@ index 421f89f..b9d329b 100644
- configuration,
- text: ' > '
- }),
+ // Only print the breadcrumb separator if it's not the first item we're printing.
+ if (!first) {
+ // Only print the breadcrumb separator if it's not the first item we're printing.
+ output.appendNodeInParagraph(
+ new tsdoc_1.DocPlainText({
+ new tsdoc_1.DocPlainText({
+ configuration,
+ text: ' > '
+ })
@@ -55,7 +55,7 @@ index 421f89f..b9d329b 100644
}
}
}
@@ -947,11 +956,13 @@ class MarkdownDocumenter {
@@ -968,11 +977,8 @@ class MarkdownDocumenter {
// For overloaded methods, add a suffix such as "MyClass.myMethod_2".
let qualifiedName = Utilities_1.Utilities.getSafeFilenameForName(hierarchyItem.displayName);
if (api_extractor_model_1.ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {
@@ -65,22 +65,16 @@ index 421f89f..b9d329b 100644
- qualifiedName += `_${hierarchyItem.overloadIndex - 1}`;
- }
+ // https://github.com/microsoft/rushstack/issues/1921
+ // if (hierarchyItem.overloadIndex > 1) {
+ // // Subtract one for compatibility with earlier releases of API Documenter.
+ // // (This will get revamped when we fix GitHub issue #1308)
+ // qualifiedName += `_${hierarchyItem.overloadIndex - 1}`;
+ // }
+ qualifiedName += `_${hierarchyItem.overloadIndex}`;
}
switch (hierarchyItem.kind) {
case api_extractor_model_1.ApiItemKind.Model:
@@ -962,7 +973,9 @@ class MarkdownDocumenter {
@@ -983,7 +989,8 @@ class MarkdownDocumenter {
baseName = Utilities_1.Utilities.getSafeFilenameForName(node_core_library_1.PackageName.getUnscopedName(hierarchyItem.displayName));
break;
default:
- baseName += '.' + qualifiedName;
+ // https://github.com/microsoft/rushstack/issues/1921
+ // baseName += '.' + qualifiedName;
+ baseName += '.' + qualifiedName + '_' + hierarchyItem.kind.toLowerCase();
}
}