Skip to content

Mark documentation comment blocks as Markdown. #37

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.

Sign up for GitHub

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

Open
AndreasBackx wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Mark documentation comment blocks as Markdown. #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions syntaxes/rust.tmLanguage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,14 @@
{
"comment": "documentation comments",
"name": "comment.line.documentation.rust",
"match": "^\\s*///.*"
"begin": "^\\s*//(/|!)",
"while": "^\\s*//(/|!)",
"contentName": "meta.embedded.block.markdown",
"patterns": [
{
"include": "text.html.markdown"
}
]
},
{
"comment": "line comments",
Expand All @@ -317,11 +324,15 @@
{
"comment": "block documentation comments",
"name": "comment.block.documentation.rust",
"begin": "/\\*\\*",
"end": "\\*/",
"begin": "/\\*(\\*|!)",
"end": "\\s*\\*/",
"contentName": "meta.embedded.block.markdown",
"patterns": [
{
"include": "#block-comments"
},
{
"include": "text.html.markdown"
}
]
},
Expand Down Expand Up @@ -1165,4 +1176,4 @@
]
}
}
}
}
12 changes: 9 additions & 3 deletions syntaxes/rust.tmLanguage.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,11 @@ repository:
-
comment: documentation comments
name: comment.line.documentation.rust
match: ^\s*///.*
begin: ^\\s*//(/|!)
while: ^\\s*//(/|!)
contentName: meta.embedded.block.markdown
patterns:
- include: text.html.markdown
-
comment: line comments
name: comment.line.double-slash.rust
Expand All @@ -174,10 +178,12 @@ repository:
-
comment: block documentation comments
name: comment.block.documentation.rust
begin: /\*\*
end: \*/
begin: /\\*(\\*|!)
end: \\s*\\*/
contentName: meta.embedded.block.markdown
patterns:
- include: '#block-comments'
- include: text.html.markdown
-
comment: block comments
name: comment.block.rust
Expand Down