| title | ae-undocumented |
|---|
"Missing documentation for ___."
This message is reported when an exported API item does not have a TSDoc doc comment. This helps ensure that every public API has proper documentation.
The ae-undocumented message is only generated if the API report feature is enabled
(apiReport.enabled is true).
Because the API report file already annotates undocumented items with // (undocumented),
the ae-undocumented message is not logged by default (its default logLevel is "none").
Add a TSDoc doc comment to the declaration. For example:
/**
* Represents the application state.
* @public
*/
export interface IAppState {
/**
* The current user name.
*/
userName: string;
}If you want to see these warnings during your build, add a section like this to your api-extractor.json file:
"messages": {
"extractorMessageReporting": {
"ae-undocumented": {
"logLevel": "warning"
}
}
}To add the messages to your API report file for tracking purposes instead:
"messages": {
"extractorMessageReporting": {
"ae-undocumented": {
"logLevel": "warning",
"addToApiReportFile": true
}
}
}