You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using doc comments (TSDoc syntax), inline tags such as {@link} or any other text containing an @-symbol cause the description to be cut off at the @-symbol.
import "@typespec/http";
using TypeSpec.Http;
/**
* Example of a description {@link https://github.com/microsoft/tsdoc}
* Some more text here
*/
@service()
namespace Service;
results in the following OpenAPI output
openapi: 3.0.0info:
title: (title)description: Example of a description {version: 0.0.0tags: []paths: {}components: {}
The same applies for any other text containing an @-symbol, like email-adresses, unless escaped with backticks.
I'm not sure to what extent TSDoc compatibility is a goal, but I've noticed tags like @param are supported, so I imagine this is a issue.
Related to #3374, this is an implementation of escaping characters in
doc comments, such as the `@` symbol.
---------
Co-authored-by: Timothee Guerin <[email protected]>
Co-authored-by: Timothee Guerin <[email protected]>
Describe the bug
When using doc comments (TSDoc syntax), inline tags such as
{@link}
or any other text containing an@
-symbol cause the description to be cut off at the@
-symbol.Reproduction
Reproduction in Playground
The following example
results in the following OpenAPI output
The same applies for any other text containing an
@
-symbol, like email-adresses, unless escaped with backticks.I'm not sure to what extent TSDoc compatibility is a goal, but I've noticed tags like
@param
are supported, so I imagine this is a issue.Checklist
The text was updated successfully, but these errors were encountered: