microsoft / microsoft/typespec
Make @example a known doc tag
Open
compiler:core
- Dominant language
- Java
- Stars
- 5.9k
- Forks
- 394
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 104
Description
# Proposal
Add `@example` as a known tag with the following format
First line is the title (optional - if line is empty then there is no title)
Rest is the tag content
```cadl
/**
* @example First line is example title
* rest is
* example
* content
*
*/
```
woudl result in the following
```json5
{
title: "First line is example title",
content: "rest is\nexample\ncontent",
}
```
Contributor guide
Assessment
This issue has not been assessed yet.