Cache element docs (and add to completions) (#23694).

pkg/analyzer/lib/src/dart/element/element.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.
 
 library analyzer.src.dart.element.element;
 
 import 'dart:collection';
 import 'dart:math' show min;
 
 import 'package:analyzer/dart/element/element.dart';
@@ skipping 1655 matching lines @@
    * A cached copy of the calculated hashCode for this element.
    */
   int _cachedHashCode;
 
   /**
    * A cached copy of the calculated location for this element.
    */
   ElementLocation _cachedLocation;
 
   /**
+   * The documentation comment for this element.
+   */
+  String _docComment;
+
+  /**
    * The offset to the beginning of the documentation comment,
    * or `null` if this element does not have a documentation comment.
    */
   int _docRangeOffset;
 
   /**
    * The length of the documentation comment range for this element.
    */
   int _docRangeLength;
 
@@ skipping 16 matching lines @@
     if (_enclosingElement == null) {
       return null;
     }
     return _enclosingElement.context;
   }
 
   @override
   String get displayName => _name;
 
   @override
   SourceRange get docRange {

[scheglov, 2015/12/17 22:10:14]

Did we decide to remove this?

[pquitslund, 2015/12/17 22:12:56]

We did and then reconsidered.  It would break API and no one is quite ready for
that pain again quite yet. ;)

     if (_docRangeOffset != null && _docRangeLength != null) {
       return new SourceRange(_docRangeOffset, _docRangeLength);
     }
     return null;
   }
 
   @override
+  String get documentationComment => _docComment;
+
+  /**
+   * The documentation comment source for this element.
+   */
+  void set documentationComment(String doc) {
+    _docComment = doc?.replaceAll('\r\n', '\n');
+  }
+
+  @override
   Element get enclosingElement => _enclosingElement;
 
   /**
    * Set the enclosing element of this element to the given [element].
    */
   void set enclosingElement(Element element) {
     _enclosingElement = element as ElementImpl;
     _cachedLocation = null;
     _cachedHashCode = null;
   }
@@ skipping 129 matching lines @@
     if (_name == null) {
       buffer.write("<unnamed ");
       buffer.write(runtimeType.toString());
       buffer.write(">");
     } else {
       buffer.write(_name);
     }
   }
 
   @override
-  String computeDocumentationComment() {
-    AnalysisContext context = this.context;
-    if (context == null) {
-      return null;
-    }
-    return context.computeDocumentationComment(this);
-  }
+  String computeDocumentationComment() => _docComment;
 
   @override
   AstNode computeNode() => getNodeMatching((node) => node is AstNode);
 
   /**
    * Set this element as the enclosing element for given [element].
    */
   void encloseElement(ElementImpl element) {
     element.enclosingElement = this;
   }
@@ skipping 1343 matching lines @@
   }
 
   @override
   List<LibraryElement> get visibleLibraries {
     Set<LibraryElement> visibleLibraries = new Set();
     _addVisibleLibraries(visibleLibraries, false);
     return new List.from(visibleLibraries);
   }
 
   @override
-  bool operator ==(Object object) => object is LibraryElementImpl &&
+  bool operator ==(Object object) =>
+      object is LibraryElementImpl &&
       _definingCompilationUnit == object.definingCompilationUnit;
 
   @override
   accept(ElementVisitor visitor) => visitor.visitLibraryElement(this);
 
   /**
    * Create the [FunctionElement] to be returned by [loadLibraryFunction],
    * using types provided by [typeProvider].
    */
   void createLoadLibraryFunction(TypeProvider typeProvider) {
@@ skipping 401 matching lines @@
     _name = conflictingElements[0].name;
   }
 
   @override
   String get displayName => _name;
 
   @override
   SourceRange get docRange => null;
 
   @override
+  String get documentationComment => null;
+
+  @override
   Element get enclosingElement => null;
 
   @override
   bool get isDeprecated => false;
 
   @override
   bool get isOverride => false;
 
   @override
   bool get isPrivate {
@@ skipping 116 matching lines @@
   static void _add(HashSet<Element> elements, Element element) {
     if (element is MultiplyDefinedElementImpl) {
       for (Element conflictingElement in element.conflictingElements) {
         elements.add(conflictingElement);
       }
     } else {
       elements.add(element);
     }
   }
 
+  // TODO: implement documentationComment

[scheglov, 2015/12/17 22:10:14]

Did you want to fix this in this CL?

[pquitslund, 2015/12/17 22:12:56]

Whoops!  Yes.  Thanks!

   /**
    * Use the given elements to construct a list of conflicting elements. If
    * either the [firstElement] or [secondElement] are multiply-defined elements
    * then the conflicting elements they represent will be included in the array.
    * Otherwise, the element itself will be included.
    */
   static List<Element> _computeConflictingElements(
       Element firstElement, Element secondElement) {
     HashSet<Element> elements = new HashSet<Element>();
     _add(elements, firstElement);
@@ skipping 412 matching lines @@
   }
 
   /**
    * Set whether this accessor is static.
    */
   void set static(bool isStatic) {
     setModifier(Modifier.STATIC, isStatic);
   }
 
   @override
-  bool operator ==(Object object) => super == object &&
+  bool operator ==(Object object) =>
+      super == object &&
       isGetter == (object as PropertyAccessorElement).isGetter;
 
   @override
   accept(ElementVisitor visitor) => visitor.visitPropertyAccessorElement(this);
 
   @override
   void appendTo(StringBuffer buffer) {
     buffer.write(isGetter ? "get " : "set ");
     buffer.write(variable.displayName);
     super.appendTo(buffer);
@@ skipping 322 matching lines @@
 
   @override
   void visitElement(Element element) {
     int offset = element.nameOffset;
     if (offset != -1) {
       map[offset] = element;
     }
     super.visitElement(element);
   }
 }