Fix navigation and constructor docs to include class generics (#1556)

* Add type parameters for constructors

* And make navigation consistently include generic types in the class.

* Update test package docs post-merge

Author: jcollins-g

lib/src/html/template_data.dart

@@ -36,7 +36,13 @@ abstract class TemplateData<T extends Documentable> {
   String get kind => self is ModelElement ? (self as ModelElement).kind : null;
 
   List get navLinks;
-  Documentable get parent => navLinks.isNotEmpty ? navLinks.last : null;
+  List get navLinksWithGenerics => [];
+  Documentable get parent {
+    if (navLinksWithGenerics.isEmpty) {
+      return navLinks.isNotEmpty ? navLinks.last : null;
+    }
+    return navLinksWithGenerics.last;
+  }
 
   bool get includeVersion => false;
 
@@ -236,7 +242,9 @@ class ConstructorTemplateData extends TemplateData<Constructor> {
   String get layoutTitle => _layoutTitle(
       constructor.name, constructor.fullKind, constructor.isDeprecated);
   @override
-  List get navLinks => [package, library, clazz];
+  List get navLinks => [package, library];
+  @override
+  List get navLinksWithGenerics => [clazz];
   @override
   Iterable<Subnav> getSubNavItems() => _gatherSubnavForInvokable(constructor);
   @override
@@ -331,7 +339,9 @@ class MethodTemplateData extends TemplateData<Method> {
       'API docs for the ${method.name} method from the ${clazz.name} class, '
       'for the Dart programming language.';
   @override
-  List get navLinks => [package, library, clazz];
+  List get navLinks => [package, library];
+  @override
+  List get navLinksWithGenerics => [clazz];
   @override
   Iterable<Subnav> getSubNavItems() => _gatherSubnavForInvokable(method);
   @override
@@ -361,7 +371,9 @@ class PropertyTemplateData extends TemplateData<Field> {
       'API docs for the ${property.name} $type from the ${clazz.name} class, '
       'for the Dart programming language.';
   @override
-  List get navLinks => [package, library, clazz];
+  List get navLinks => [package, library];
+  @override
+  List get navLinksWithGenerics => [clazz];
   @override
   String get htmlBase => '../..';
 

lib/src/model.dart

@@ -1126,11 +1126,15 @@ class Class extends ModelElement
 }
 
 class Constructor extends ModelElement
-    with SourceCodeMixin
+    with SourceCodeMixin, TypeParameters
     implements EnclosedElement {
   Constructor(ConstructorElement element, Library library)
       : super(element, library, null);
 
+  @override
+  // TODO(jcollins-g): Revisit this when dart-lang/sdk#31517 is implemented.
+  List<TypeParameter> get typeParameters => (enclosingElement as Class).typeParameters;
+
   @override
   ModelElement get enclosingElement =>
       new ModelElement.from(_constructor.enclosingElement, library);
@@ -1172,6 +1176,20 @@ class Constructor extends ModelElement
     return _name;
   }
 
+  String _nameWithGenerics;
+  @override
+  String get nameWithGenerics {
+    if (_nameWithGenerics == null) {
+      String constructorName = element.name;
+      if (constructorName.isEmpty) {
+        _nameWithGenerics = '${enclosingElement.name}${genericParameters}';
+      } else {
+        _nameWithGenerics = '${enclosingElement.name}${genericParameters}.$constructorName';
+      }
+    }
+    return _nameWithGenerics;
+  }
+
   String get shortName {
     if (name.contains('.')) {
       return name.substring(_constructor.enclosingElement.name.length + 1);
@@ -4689,8 +4707,6 @@ abstract class SourceCodeMixin {
 }
 
 abstract class TypeParameters implements Nameable {
-  Element get element;
-
   String get nameWithGenerics => '$name$genericParameters';
 
   String get genericParameters {

lib/templates/_head.html

@@ -37,6 +37,9 @@
     {{#navLinks}}
     <li><a href="{{href}}">{{name}}</a></li>
     {{/navLinks}}
+    {{#navLinksWithGenerics}}
+    <li><a href="{{href}}">{{name}}{{{genericParameters}}}</a></li>
+    {{/navLinksWithGenerics}}
     {{^hasHomepage}}
     <li class="self-crumb">{{{ layoutTitle }}}</li>
     {{/hasHomepage}}

lib/templates/constructor.html

@@ -8,8 +8,17 @@ <h5>{{parent.kind}} {{parent.name}}</h5>
   <div class="col-xs-12 col-sm-9 col-md-8 main-content">
     {{#constructor}}
     <section class="multi-line-signature">
+      {{#hasAnnotations}}
+      <div>
+        <ol class="annotation-list">
+          {{#annotations}}
+          <li>{{{.}}}</li>
+          {{/annotations}}
+        </ol>
+      </div>
+      {{/hasAnnotations}}
       {{#isConst}}const{{/isConst}}
-      {{>name_summary}}(<wbr>{{#hasParameters}}{{{linkedParamsLines}}}{{/hasParameters}})
+      <span class="name {{#isDeprecated}}deprecated{{/isDeprecated}}">{{{nameWithGenerics}}}</span>(<wbr>{{#hasParameters}}{{{linkedParamsLines}}}{{/hasParameters}})
     </section>
 
     {{>documentation}}

test/model_test.dart

@@ -1915,15 +1915,26 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
   group('Constructor', () {
     Constructor appleDefaultConstructor, constCatConstructor;
     Constructor appleConstructorFromString;
-    Class apple, constCat;
+    Constructor constructorTesterDefault, constructorTesterFromSomething;
+    Class apple, constCat, constructorTester;
     setUp(() {
       apple = exLibrary.classes.firstWhere((c) => c.name == 'Apple');
       constCat = exLibrary.classes.firstWhere((c) => c.name == 'ConstantCat');
+      constructorTester = fakeLibrary.classes.firstWhere((c) => c.name == 'ConstructorTester');
       constCatConstructor = constCat.constructors[0];
       appleDefaultConstructor =
           apple.constructors.firstWhere((c) => c.name == 'Apple');
       appleConstructorFromString =
           apple.constructors.firstWhere((c) => c.name == 'Apple.fromString');
+      constructorTesterDefault =
+          constructorTester.constructors.firstWhere((c) => c.name == 'ConstructorTester');
+      constructorTesterFromSomething =
+          constructorTester.constructors.firstWhere((c) => c.name == 'ConstructorTester.fromSomething');
+    });
+
+    test('displays generic parameters correctly', () {
+      expect(constructorTesterDefault.nameWithGenerics, 'ConstructorTester<A, B>');
+      expect(constructorTesterFromSomething.nameWithGenerics, 'ConstructorTester<A, B>.fromSomething');
     });
 
     test('has a fully qualified name', () {

testing/test_package/lib/fake.dart

@@ -74,6 +74,11 @@ abstract class BaseThingy2 implements BaseThingy {
   ImplementingThingy2 get aImplementingThingy;
 }
 
+class ConstructorTester<A, B> {
+  ConstructorTester(String param1) {}
+  ConstructorTester.fromSomething(A foo) {}
+}
+
 class HasGenerics<X, Y, Z> {
   HasGenerics(X x, Y y, Z z) {}
 

testing/test_package_docs/ex/AnotherParameterizedClass/AnotherParameterizedClass.html

@@ -25,7 +25,7 @@
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="index.html">test_package</a></li>
     <li><a href="ex/ex-library.html">ex</a></li>
-    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a></li>
+    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass&lt;B&gt;</a></li>
     <li class="self-crumb">constructor AnotherParameterizedClass</li>
   </ol>
   <div class="self-name">AnotherParameterizedClass</div>
@@ -63,7 +63,7 @@ <h5>class AnotherParameterizedClass</h5>
   <div class="col-xs-12 col-sm-9 col-md-8 main-content">
     <section class="multi-line-signature">
 
-            <span class="name ">AnotherParameterizedClass</span>(<wbr>)
+      <span class="name ">AnotherParameterizedClass&lt;B&gt;</span>(<wbr>)
     </section>
 
 

testing/test_package_docs/ex/AnotherParameterizedClass/hashCode.html

@@ -25,7 +25,7 @@
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="index.html">test_package</a></li>
     <li><a href="ex/ex-library.html">ex</a></li>
-    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a></li>
+    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass&lt;B&gt;</a></li>
     <li class="self-crumb">property hashCode</li>
   </ol>
   <div class="self-name">hashCode</div>

testing/test_package_docs/ex/AnotherParameterizedClass/noSuchMethod.html

@@ -25,7 +25,7 @@
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="index.html">test_package</a></li>
     <li><a href="ex/ex-library.html">ex</a></li>
-    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a></li>
+    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass&lt;B&gt;</a></li>
     <li class="self-crumb">method noSuchMethod</li>
   </ol>
   <div class="self-name">noSuchMethod</div>

testing/test_package_docs/ex/AnotherParameterizedClass/operator_equals.html

@@ -25,7 +25,7 @@
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="index.html">test_package</a></li>
     <li><a href="ex/ex-library.html">ex</a></li>
-    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a></li>
+    <li><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass&lt;B&gt;</a></li>
     <li class="self-crumb">method operator ==</li>
   </ol>
   <div class="self-name">operator ==</div>