fast icon indicating copy to clipboard operation
fast copied to clipboard

fix: API Extractor produces warnings for param blocks

Open radium-v opened this issue 3 months ago • 0 comments

🐛 Bug Report

Some of our documentation blocks are invalid and create warnings when building.

💻 Repro or Code Sample

Analysis will use the bundled TypeScript version 5.4.2
Warning: dist/dts/context.d.ts:102:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:103:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:104:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:120:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:121:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:122:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
API Extractor completed successfully for /Users/jak/src/fast/packages/fast-element/api-extractor.context.json
Analysis will use the bundled TypeScript version 5.4.2
Warning: dist/dts/context.d.ts:102:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:103:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:104:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:120:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:121:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/context.d.ts:122:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: dist/dts/di/di.d.ts:396:5 - (ae-unresolved-link) The @link reference could not be resolved: The package "@microsoft/fast-element" does not have an export "Observable"
API Extractor completed successfully for /Users/jak/src/fast/packages/fast-element/api-extractor.di.json

🤔 Expected Behavior

These warnings shouldn't be present.

😯 Current Behavior

When running api-extractor run --local in fast-element, the warnings are printed.

💁 Possible Solution

Clean up the documentation!

radium-v avatar Nov 24 '25 23:11 radium-v