Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: preserve jsdoc comments on class #3798

Closed
3 tasks done
ysulyma opened this issue Nov 7, 2022 · 1 comment
Closed
3 tasks done

feat: preserve jsdoc comments on class #3798

ysulyma opened this issue Nov 7, 2022 · 1 comment
Labels

Comments

@ysulyma
Copy link

ysulyma commented Nov 7, 2022

Prerequisites

Describe the Feature Request

JSDoc comments on classes (rather than on their props) are not included in components.d.ts. I would like them to be. I will submit a PR for this.

Describe the Use Case

More information in type annotations.

Describe Preferred Solution

No response

Describe Alternatives

No response

Related Code

The following code

/**
 * Example component
 */
@Component({
  tag: 'my-component',
  shadow: true,
})
export class MyComponent {
  /**
   * Example property
   */
  @Prop() prop: string;
}

produces the following components.d.ts:

interface MyComponent {
  /**
   * Example property
   */
  prop: string;
}

I would like it to produce

/**
 * Example component
 */
interface MyComponent {
  /**
   * Example property
   */
  prop: string;
}

Additional Information

No response

@rwaskiewicz
Copy link
Contributor

Thanks @ysulyma!

I appreciate the PR! I'm going to close the issue (not the PR) as a duplicate of #3524. The team will be looking into the PR during our next sprint. Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants