Merge pull request #1056 from keertip/typedefs

show generics for typedefs

Author: keertip

CHANGELOG.md

@@ -1,6 +1,8 @@
 ## 0.8.4
 * [enhancement] Only include generator metadata in the package `index.html` file.
 * [bug] Fixed the display of deprecated properties.
+* [bug] show generics for typedefs
+* [bug] cleanly unzip docs on Mac
 
 ## 0.8.3
 * [enhancement] Added `--[no-]include-source` option.

lib/src/html/template_data.dart

@@ -308,7 +308,7 @@ class TypedefTemplateData extends TemplateData<Typedef> {
   String get title =>
       '${typeDef.name} typedef - ${library.name} library - Dart API';
   String get layoutTitle =>
-      _layoutTitle(typeDef.name, 'typedef', typeDef.isDeprecated);
+      _layoutTitle(typeDef.nameWithGenerics, 'typedef', typeDef.isDeprecated);
   String get metaDescription =>
       'API docs for the ${typeDef.name} property from the '
       '${library.name} library, for the Dart programming language.';

lib/src/model.dart

@@ -1498,6 +1498,16 @@ class Typedef extends ModelElement implements EnclosedElement {
 
   String get fileName => '$name.html';
 
+  String get nameWithGenerics {
+    if (!modelType.isParameterizedType) return name;
+    String n = '$name<${_typeParameters.map((t) => t.name).join(', ')}>';
+    return '$name<${_typeParameters.map((t) => t.name).join(', ')}>';
+  }
+
+  List<TypeParameter> get _typeParameters => _typedef.typeParameters.map((f) {
+        return new TypeParameter(f, library);
+      }).toList();
+
   String get linkedReturnType => modelType != null
       ? modelType.createLinkedReturnTypeName()
       : _typedef.returnType.name;

test_package/lib/example.dart

@@ -19,7 +19,7 @@ const String COLOR_ORANGE = 'orange';
 const String COMPLEX_COLOR = 'red' + '-' + 'green' + '-' + 'blue';
 const ConstantCat MY_CAT = const ConstantCat('tabby');
 
-typedef String processMessage(String msg);
+typedef String processMessage<T>(String msg);
 
 /// This should [not work].
 const incorrectDocReferenceFromEx = 'doh';

test_package_docs/ex/processMessage.html

@@ -53,7 +53,7 @@
         </ol>
         <div class="title-description">
           <h1 class="title">
-            <span class="kind">typedef</span> processMessage
+            <span class="kind">typedef</span> processMessage&lt;T&gt;
           </h1>
         </div>
       </div> <!-- /col -->