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

[Bug]: Doc comments are cut off at inline tags #3374

Closed
4 tasks done
rmhartog opened this issue May 16, 2024 · 2 comments
Closed
4 tasks done

[Bug]: Doc comments are cut off at inline tags #3374

rmhartog opened this issue May 16, 2024 · 2 comments
Labels
bug Something isn't working needs-area

Comments

@rmhartog
Copy link
Contributor

rmhartog commented May 16, 2024

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

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.0
info:
  title: (title)
  description: Example of a description {
  version: 0.0.0
tags: []
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.

Checklist

@timotheeguerin
Copy link
Member

we do not support that syntax just yet but it is on our plans, see this issue #1358

@markcowl
Copy link
Contributor

Closing as duplicate of: #1358

@markcowl markcowl closed this as not planned Won't fix, can't repro, duplicate, stale May 20, 2024
github-merge-queue bot pushed a commit that referenced this issue Jun 11, 2024
Related to #3374, this is an implementation of escaping characters in
doc comments, such as the `@` symbol.

---------

Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com>
Co-authored-by: Timothee Guerin <tiguerin@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working needs-area
Projects
None yet
Development

No branches or pull requests

3 participants