better-docs icon indicating copy to clipboard operation
better-docs copied to clipboard

Non-annotated properties ignored in typescript

Open ThibaultJanBeyer opened this issue 5 years ago • 1 comments

Given:

class Foo {
  /** @param bar some-info */
  constructor({ bar = 'bar' }: { bar: string }) { }

  baz(something:string) {}
}

Gives following output: Screenshot 2020-11-02 at 03 28 42

As you can see, it's ignoring those parts that do not have js-doc comments.

  • i.e. the method baz is completely ignored/undocumented
  • i.e. the constructor is docummented because it has a jsdoc comment BUT the Parameter types (which are set via typescript notation) are ignored.

I'd exept a "native" typescript support?

ThibaultJanBeyer avatar Nov 02 '20 02:11 ThibaultJanBeyer

related to #115

wojtek-krysiak avatar Nov 02 '20 04:11 wojtek-krysiak