microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.7k stars 130 forks source link

Support for field documentation in a type alias #302

Closed bdwain closed 2 years ago

bdwain commented 2 years ago
export interface MyInterface {
  /** this is supported */
  str: string;
}

export type MyType = {
  /** this is not supported */
  str: string;
};

Can support for type aliases be added? They are basically equivalent. https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#differences-between-type-aliases-and-interfaces

bdwain commented 2 years ago

just realized the problem i am seeing is not in tsdoc