Skip to content

feat(docs): scrape default slot meta via vdom when there's no jsdocs  #6629

@scriptcoded

Description

@scriptcoded

Prerequisites

Describe the Feature Request

Hej!

The Stencil compiler automatically finds props and events that can then be automatically documented. The compiler also finds slots, but only through JSDoc. Seeing as the compiler has access to the complete component source code, would it be possible to automatically find slots in the code and document these? The @slot tag could still be used to write manual documentation for slots.

Describe the Use Case

By automatically finding slots in the source code it would show up in documentation. I'd argue it's better to have the slots acknowledged without a human written description than not exist there at all.

Describe Preferred Solution

I'd like for the compiler to both find slots in the source code and the JSDoc tags and add these to the documentation, be it JSON, Markdown or something else.

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stencil v5This is slated for Stencil v5 (Release date TBD)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions