Scaladoc: Allow to set a comment syntax based on path to source #14650
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pikinier20
suggested changes
Mar 9, 2022
jchyb
force-pushed
the
scaladoc/comment-syntax-overrides
branch
2 times, most recently
from
cc89009
to
f481fbe
Compare
jchyb
force-pushed
the
scaladoc/comment-syntax-overrides
branch
from
f481fbe
to
d0290ee
Compare
pikinier20
reviewed
Mar 14, 2022
pikinier20
reviewed
Mar 16, 2022
Comment on lines
20
to
25
| CommentSyntax.CommentSyntaxParser.parse(commentSetting).getOrElse { | ||
| val msg = s"not a valid comment syntax: $commentSetting, defaulting to Markdown syntax." | ||
| // we should update pos with span from documentation | ||
| pos.fold(report.warning(msg))(report.warning(msg, _)) | ||
|
|
||
| CommentSyntax.default |
There was a problem hiding this comment.
Shouldn't we here fall back to the syntax based on path?
pikinier20
suggested changes
Mar 16, 2022
jchyb
force-pushed
the
scaladoc/comment-syntax-overrides
branch
from
d0290ee
to
196f207
Compare
CommentSyntax option now allows to set the comment syntax based on a passed path prefix. This will allow to use a correct syntax for specific files in one project, for example a wiki syntax for scalalib and md syntax for dottylib.
Those consist of packages example.comment.md and example.comment.wiki configured with a matching comment syntax.
Wiki syntax was set for scala 2.13 stdlib and markdown was set for scala 3 stdlib.
jchyb
force-pushed
the
scaladoc/comment-syntax-overrides
branch
from
196f207
to
8766c44
Compare
pikinier20
approved these changes
Mar 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new Scaladoc option: CommentSyntaxOverrides, which allows to override the project wide comment syntax with one set based on a path prefix to a source file.This PR revises
-comment-syntaxoption to use the PathBased abstraction. This will allow to use multiple syntaxes in one project. The previous style of option passing (one syntax format for the whole project) will still work.Additionally in the dotty repo the following paths were set with this option:
scaladoc-testcasesexamples showcasing the feature (in theexamples.comment.markdownandexamples.comment.wikipackages)Resolves #14596