Skip to content

Commit

Permalink
Update docs-readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@rwaskiewicz
rwaskiewicz authored Mar 28, 2024
1 parent bfef5cd commit ddb20ed
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/documentation-generation/docs-readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Any custom content placed above this comment will be persisted on subsequent bui

### Internal Components

A Stencil component may be marked as deprecated using the unofficial JSDoc `@internal` tag.
A Stencil component may be marked as internal to a library using the unofficial JSDoc `@internal` tag.
By placing `@internal` in a component's class-level JSDoc it will skip the generation of the README for the component.

In the code block below, `@internal` is added to the JSDoc for `MyComponent`:
Expand Down

0 comments on commit ddb20ed

Please sign in to comment.