ionic-team / stencil

A toolchain for building scalable, enterprise-ready component systems on top of TypeScript and Web Component standards. Stencil components can be distributed natively to React, Angular, Vue, and traditional web developers from a single, framework-agnostic codebase.
https://stenciljs.com
Other
12.41k stars 778 forks source link

feat: Generate Documentation For Classes/Interfaces #3146

Closed zimaah closed 2 years ago

zimaah commented 2 years ago

Prerequisites

Describe the Feature Request

class and interface documentation generated along with props documentation.

Describe the Use Case

As a developer consuming a web component library built with StencilJS I would like to see the component documentation (from its class or interface) when hovering its markup.

Describe Preferred Solution

// my-interface.ts

/**
 MyInterface Docs
*/
interface MyInterface {

   /**
    prop Docs
   */
   prop: string;
}

// my-component.tsx
export class MyComponent implements MyInterface {
   // ...
}
// consuming the lib

<my-component prop={"hello world"} />

When hovering <my-component> I should be able to see the class/interface documentation.

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

splitinfinities commented 2 years ago

Going to close this as a duplicate, but mark this https://github.com/ionic-team/stencil/issues/2906 as the leading issue.