Merge pull request #99 from resolritter/doc_comments

Designate doc comments

Author: aryx

corpus/source_files.txt

@@ -55,6 +55,36 @@ Line comments
 (source_file
   (line_comment))
 
+============================================
+Doc comments
+============================================
+
+/// Doc
+/// Comment
+// / Now a line comment (note the space separating the third slash)
+
+/// Doc
+/// Comment
+//// Four slashes makes the line a normal comment
+/// Doc comment got interrupted by the line above
+
+//! Inner doc comment line 1
+//! Inner doc comment line 2
+/// This is different doc comment since the line starts differently
+//! Back to inner doc comment
+
+----
+
+(source_file
+  (doc_comment)
+  (line_comment)
+  (doc_comment)
+  (line_comment)
+  (doc_comment)
+  (doc_comment)
+  (doc_comment)
+  (doc_comment))
+
 =====================================
 Greek letters in identifiers
 =====================================

grammar.js

@@ -38,13 +38,15 @@ const primitive_types = numeric_types.concat(['bool', 'str', 'char'])
 module.exports = grammar({
   name: 'rust',
 
-  extras: $ => [/\s/, $.line_comment, $.block_comment],
+  extras: $ => [/\s/, $.line_comment, $.block_comment, $.doc_comment],
 
   externals: $ => [
     $._string_content,
     $.raw_string_literal,
     $.float_literal,
     $.block_comment,
+    $.line_comment,
+    $.doc_comment
   ],
 
   supertypes: $ => [
@@ -1426,15 +1428,6 @@ module.exports = grammar({
 
     boolean_literal: $ => choice('true', 'false'),
 
-    comment: $ => choice(
-      $.line_comment,
-      $.block_comment
-    ),
-
-    line_comment: $ => token(seq(
-      '//', /.*/
-    )),
-
     _path: $ => choice(
       $.self,
       alias(choice(...primitive_types), $.identifier),

src/grammar.json

@@ -8173,35 +8173,6 @@
         }
       ]
     },
-    "comment": {
-      "type": "CHOICE",
-      "members": [
-        {
-          "type": "SYMBOL",
-          "name": "line_comment"
-        },
-        {
-          "type": "SYMBOL",
-          "name": "block_comment"
-        }
-      ]
-    },
-    "line_comment": {
-      "type": "TOKEN",
-      "content": {
-        "type": "SEQ",
-        "members": [
-          {
-            "type": "STRING",
-            "value": "//"
-          },
-          {
-            "type": "PATTERN",
-            "value": ".*"
-          }
-        ]
-      }
-    },
     "_path": {
       "type": "CHOICE",
       "members": [
@@ -8382,6 +8353,10 @@
     {
       "type": "SYMBOL",
       "name": "block_comment"
+    },
+    {
+      "type": "SYMBOL",
+      "name": "doc_comment"
     }
   ],
   "conflicts": [
@@ -8427,6 +8402,14 @@
     {
       "type": "SYMBOL",
       "name": "block_comment"
+    },
+    {
+      "type": "SYMBOL",
+      "name": "line_comment"
+    },
+    {
+      "type": "SYMBOL",
+      "name": "doc_comment"
     }
   ],
   "inline": [

src/node-types.json

@@ -4939,6 +4939,10 @@
     "type": "default",
     "named": false
   },
+  {
+    "type": "doc_comment",
+    "named": true
+  },
   {
     "type": "dyn",
     "named": false