microsoft / rushstack-websites

Doc content for the Rush Stack websites.
Creative Commons Attribution 4.0 International
27 stars 73 forks source link

@typeParam property can not work as expected #257

Open tolerious opened 5 months ago

tolerious commented 5 months ago

Here is an example hosted by StackBlize

I created a generic interface called Box and added a @typeParam document property <T> for this class. Nevertheless, after I generated the markdown document for this interface, there was no description regarding the T, which is very strange.

/**
 * Box interface.
 * @typeParam T - Box type
 * @public
 */
export interface Box<T> {
  type: T;
}

When you open the Stackblize link, just run npm run dev, it will call api-extractor and api-documenter automatically.