Skip to content

CommentSyntax setting should be path based #14596

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

Closed
pikinier20 opened this issue Mar 1, 2022 · 0 comments · Fixed by #14650
Closed

CommentSyntax setting should be path based #14596

pikinier20 opened this issue Mar 1, 2022 · 0 comments · Fixed by #14650

Comments

@pikinier20
Copy link
Contributor

The -comment-syntax setting tells Scaladoc whether the docstrings are written in Markdown or Wiki syntax. For now, the comment syntax setting can only be set globally for entire project. In Dotty we have the Scala 2.13 standard library which uses Wiki syntax and Scala 3 standard library which uses Markdown.

Currently we use the Wiki syntax for entire project because Wiki parser handles Markdown quite well.

Having in mind that new comments should be written in Markdown syntax, there are few features that work only with Markdown (e.g. snippet compiler) and therefore it would be nice if we could set correct syntaxes for specific libraries in Dotty.

Also, it might help in migration process of other libraries from Scala 2 to Scala 3.

The implementation should be easy because there's PathBased abstraction that is already used for source links and snippet compiler. Using this abstraction we can decide which syntax should be used based on the path to the class file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants