diff --git a/apps/api-extractor/src/schemas/api-extractor-template.json b/apps/api-extractor/src/schemas/api-extractor-template.json index a2716e5d88b..4e1f7be9e12 100644 --- a/apps/api-extractor/src/schemas/api-extractor-template.json +++ b/apps/api-extractor/src/schemas/api-extractor-template.json @@ -182,9 +182,9 @@ * prepend a folder token such as "". * * SUPPORTED TOKENS: , , - * DEFAULT VALUE: "/temp/" + * DEFAULT VALUE: "/etc/" */ - // "reportFolder": "/temp/", + // "reportFolder": "/etc/", /** * Specifies the folder where the temporary report file is written. The file name portion is determined by @@ -249,7 +249,7 @@ * item's file path is "api/ExtractorConfig.ts", the full URL file path would be * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js". * - * Can be omitted if you don't need source code links in your API documentation reference. + * This setting can be omitted if you don't need source code links in your API documentation reference. * * SUPPORTED TOKENS: none * DEFAULT VALUE: "" @@ -284,6 +284,8 @@ * Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release. * This file will include only declarations that are marked as "@public", "@beta", or "@alpha". * + * If the path is an empty string, then this file will not be written. + * * The path is resolved relative to the folder of the config file that contains the setting; to change this, * prepend a folder token such as "". * @@ -296,6 +298,8 @@ * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. * This file will include only declarations that are marked as "@public" or "@beta". * + * If the path is an empty string, then this file will not be written. + * * The path is resolved relative to the folder of the config file that contains the setting; to change this, * prepend a folder token such as "". * diff --git a/common/changes/@microsoft/api-extractor/octogonz-ae-reportfilename-extension_2024-07-23-18-27.json b/common/changes/@microsoft/api-extractor/octogonz-ae-reportfilename-extension_2024-07-23-18-27.json new file mode 100644 index 00000000000..752ad7dd46f --- /dev/null +++ b/common/changes/@microsoft/api-extractor/octogonz-ae-reportfilename-extension_2024-07-23-18-27.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-extractor", + "comment": "", + "type": "none" + } + ], + "packageName": "@microsoft/api-extractor" +} \ No newline at end of file