Extract DocumentationCommentToken with field.

pkg/analyzer/lib/src/generated/parser.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 // This code was auto-generated, is not intended to be edited, and is subject to
 // significant change. Please see the README file for more information.
 
 library engine.parser;
 
 import "dart:math" as math;
@@ skipping 5440 matching lines @@
    * commentReference ::=
    *     '[' 'new'? qualified ']' libraryReference?
    *
    * libraryReference ::=
    *      '(' stringLiteral ')'
    * </pre>
    *
    * @param tokens the comment tokens representing the documentation comments to be parsed
    * @return the comment references that were parsed
    */
-  List<CommentReference> _parseCommentReferences(List<CommentToken> tokens) {
+  List<CommentReference>
+      _parseCommentReferences(List<DocumentationCommentToken> tokens) {
     List<CommentReference> references = new List<CommentReference>();
-    for (CommentToken token in tokens) {
+    for (DocumentationCommentToken token in tokens) {
       String comment = token.lexeme;
       int length = comment.length;
       List<List<int>> codeBlockRanges = _getCodeBlockRanges(comment);
       int leftIndex = comment.indexOf('[');
       while (leftIndex >= 0 && leftIndex + 1 < length) {
         List<int> range = _findRange(codeBlockRanges, leftIndex);
         if (range == null) {
           int nameOffset = token.offset + leftIndex + 1;
           int rightIndex = JavaString.indexOf(comment, ']', leftIndex);
           if (rightIndex >= 0) {
@@ skipping 536 matching lines @@
    *
    * <pre>
    * documentationComment ::=
    *     multiLineComment?
    *   | singleLineComment*
    * </pre>
    *
    * @return the documentation comment that was parsed, or `null` if there was no comment
    */
   Comment _parseDocumentationComment() {
-    List<CommentToken> commentTokens = <CommentToken>[];
+    List<DocumentationCommentToken> documentationTokens =
+        <DocumentationCommentToken>[
+        ];
     CommentToken commentToken = _currentToken.precedingComments;
     while (commentToken != null) {
-      if (commentToken.type == TokenType.SINGLE_LINE_COMMENT) {
-        if (StringUtilities.startsWith3(
-            commentToken.lexeme,
-            0,
-            0x2F,
-            0x2F,
-            0x2F)) {
-          if (commentTokens.length == 1 &&
-              StringUtilities.startsWith3(commentTokens[0].lexeme, 0, 0x2F, 0x2A, 0x2A)) {
-            commentTokens.clear();
-          }
-          commentTokens.add(commentToken);
-        }
-      } else {
-        if (StringUtilities.startsWith3(
-            commentToken.lexeme,
-            0,
-            0x2F,
-            0x2A,
-            0x2A)) {
-          commentTokens.clear();
-          commentTokens.add(commentToken);
-        }
+      if (commentToken is DocumentationCommentToken) {
+        documentationTokens.add(commentToken);

[Brian Wilkerson, 2014/12/01 23:08:43]

This doesn't give us the semantics we want (obviously we're missing test cases)
because it allows a combination of block and end-of-line comments to all provide
a single documentation comment, such as

  /**
   * This is a single
   */
  /// documentation comment.

Previously we would keep either the last block comment or the end-of-line
comments that were not followed by a block comment.

[scheglov, 2014/12/01 23:27:53]

Done.

       }
       commentToken = commentToken.next;
     }
-    if (commentTokens.isEmpty) {
+    if (documentationTokens.isEmpty) {
       return null;
     }
-    List<CommentReference> references = _parseCommentReferences(commentTokens);
+    List<CommentReference> references =
+        _parseCommentReferences(documentationTokens);
     return Comment.createDocumentationCommentWithReferences(
-        commentTokens,
+        documentationTokens,
         references);
   }
 
   /**
    * Parse a do statement.
    *
    * <pre>
    * doStatement ::=
    *     'do' statement 'while' '(' expression ')' ';'
    * </pre>
@@ skipping 5979 matching lines @@
    * Copy resolution data from one node to another.
    *
    * @param fromNode the node from which resolution information will be copied
    * @param toNode the node to which resolution information will be copied
    */
   static void copyResolutionData(AstNode fromNode, AstNode toNode) {
     ResolutionCopier copier = new ResolutionCopier();
     copier._isEqualNodes(fromNode, toNode);
   }
 }