Issue 4497. Show the best known type in the text hover.

editor/tools/plugins/com.google.dart.tools.core/src/com/google/dart/tools/core/utilities/dartdoc/DartDocUtilities.java

 /*
  * Copyright (c) 2012, the Dart project authors.
  * 
  * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
  * in compliance with the License. You may obtain a copy of the License at
  * 
  * http://www.eclipse.org/legal/epl-v10.html
  * 
  * Unless required by applicable law or agreed to in writing, software distributed under the License
  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
 
 package com.google.dart.tools.core.utilities.dartdoc;
 
 import com.google.dart.engine.context.AnalysisException;
 import com.google.dart.engine.element.ClassElement;
 import com.google.dart.engine.element.CompilationUnitElement;
 import com.google.dart.engine.element.ConstructorElement;
 import com.google.dart.engine.element.Element;
 import com.google.dart.engine.element.ExecutableElement;
 import com.google.dart.engine.element.FieldElement;
 import com.google.dart.engine.element.FieldFormalParameterElement;
+import com.google.dart.engine.element.FunctionElement;
 import com.google.dart.engine.element.LibraryElement;
 import com.google.dart.engine.element.LocalVariableElement;
 import com.google.dart.engine.element.MethodElement;
 import com.google.dart.engine.element.ParameterElement;
 import com.google.dart.engine.element.PropertyAccessorElement;
 import com.google.dart.engine.element.TopLevelVariableElement;
 import com.google.dart.engine.element.TypeParameterElement;
 import com.google.dart.engine.element.VariableElement;
 import com.google.dart.engine.element.visitor.SimpleElementVisitor;
 import com.google.dart.engine.source.Source;
 import com.google.dart.engine.source.Source.ContentReceiver;
+import com.google.dart.engine.type.Type;
 import com.google.dart.engine.utilities.dart.ParameterKind;
 import com.google.dart.engine.utilities.source.SourceRange;
 import com.google.dart.tools.core.DartCore;
 
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.StringReader;
 import java.nio.CharBuffer;
 
 /**
  * A utility class for dealing with Dart doc text.
  * 
  * @coverage dart.tools.core.utilities
  */
 public final class DartDocUtilities {
 
   private static class DocumentingVisitor extends SimpleElementVisitor<String> {
+    private Type elementType;
+
+    public DocumentingVisitor(Type type) {
+      this.elementType = type;
+    }
+
     @Override
     public String visitClassElement(ClassElement element) {
 
       LibraryElement library = element.getLibrary();
 
       if (library != null) {
         String libraryName = library.getDisplayName();
         if (libraryName != null && libraryName.length() > 0) {
           return getTypeName(element) + " - " + libraryName;
         }
@@ skipping 17 matching lines @@
     public String visitFieldElement(FieldElement element) {
       return getTypeName(element) + " " + element.getDisplayName();
     }
 
     @Override
     public String visitFieldFormalParameterElement(FieldFormalParameterElement element) {
       return getTypeName(element) + " " + element.getDisplayName();
     }
 
     @Override
-    public String visitFunctionElement(com.google.dart.engine.element.FunctionElement element) {
+    public String visitFunctionElement(FunctionElement element) {
       return getDescription(element);
     }
 
     @Override
     public String visitLocalVariableElement(LocalVariableElement element) {
       return getTypeName(element) + " " + element.getDisplayName();
     }
 
     @Override
     public String visitMethodElement(MethodElement element) {
@@ skipping 166 matching lines @@
         }
       }
       return "dynamic";
     }
 
     private String getTypeName(ClassElement element) {
       return getName(element.getType());
     }
 
     private String getTypeName(VariableElement element) {
-      return getName(element.getType());
+      Type type = element.getType();
+      if (elementType != null) {
+        type = elementType;
+      }
+      return getName(type);
     }
 
   }
 
   /**
    * Convert from a Dart doc string with slashes and stars to a plain text representation of the
    * comment.
    * 
    * @param str
    * @return
@@ skipping 78 matching lines @@
   public static String getDartDocAsHtml(String docString) {
     if (docString != null) {
       return convertToHtml(cleanDartDoc(docString));
     }
     return null;
   }
 
   /**
    * Return a one-line description of the given Element.
    * 
-   * @param the element to document
+   * @param type the best known {@link Type} of the given {@link Element}
+   * @param element the {@link Element} to document
    * @return a String summarizing this element, or {@code null} if there is no suitable
    *         documentation
    */
-  public static String getTextSummary(Element element) {
-
+  public static String getTextSummary(Type type, Element element) {
     if (element != null) {
-      String description = element.accept(new DocumentingVisitor());
+      String description = element.accept(new DocumentingVisitor(type));
       if (description != null) {
         return description;
       }
     }
-
     return null;
   }
 
   /**
    * Return a one-line description of the given Element as html
    */
-  public static String getTextSummaryAsHtml(Element element) {
-    String summary = getTextSummary(element);
+  public static String getTextSummaryAsHtml(Type type, Element element) {
+    String summary = getTextSummary(type, element);
     if (summary == null) {
       return null;
     }
     return escapeHtmlEntities(summary);
   }
 
   private static String convertListItems(String[] lines) {
     StringBuffer buf = new StringBuffer();
 
     boolean wasCode = false;
@@ skipping 93 matching lines @@
     }
     builder.append(string, start, string.length());
     return builder.toString();
   }
 
   private DartDocUtilities() {
 
   }
 
 }