Skip to content

Commit f43815c

Browse files
jcollins-gjcollins-g
authored
Cosmetic cleanups for generic types (#1558)
1 parent ece0eea commit f43815c

File tree

186 files changed

+384
-331
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

186 files changed

+384
-331
lines changed

‎lib/src/element_type.dart‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,23 +54,52 @@ class ElementType extends Privacy {
5454
if (isParameterizedType) {
5555
if (!typeArguments.every((t) => t.linkedName == 'dynamic') &&
5656
typeArguments.isNotEmpty) {
57+
buf.write('<span class="signature">');
5758
buf.write('&lt;');
5859
buf.writeAll(typeArguments.map((t) => t.linkedName), ', ');
5960
buf.write('&gt;');
61+
buf.write('</span>');
6062
}
6163
// Hide parameters if there's a an explicit typedef behind this
6264
// element, but if there is no typedef, be explicit.
6365
if (element is ModelFunctionAnonymous) {
66+
buf.write('<span class="signature">');
6467
buf.write('(');
6568
buf.write(element.linkedParams());
6669
buf.write(')');
70+
buf.write('</span>');
6771
}
6872
}
6973
_linkedName = buf.toString();
7074
}
7175
return _linkedName;
7276
}
7377

78+
String _nameWithGenerics;
79+
String get nameWithGenerics {
80+
if (_nameWithGenerics == null) {
81+
StringBuffer buf = new StringBuffer();
82+
83+
if (isParameterType) {
84+
buf.write(name);
85+
} else {
86+
buf.write(element.name);
87+
}
88+
89+
// not TypeParameterType or Void or Union type
90+
if (isParameterizedType) {
91+
if (!typeArguments.every((t) => t.linkedName == 'dynamic') &&
92+
typeArguments.isNotEmpty) {
93+
buf.write('&lt;');
94+
buf.writeAll(typeArguments.map((t) => t.nameWithGenerics), ', ');
95+
buf.write('&gt;');
96+
}
97+
}
98+
_nameWithGenerics = buf.toString();
99+
}
100+
return _nameWithGenerics;
101+
}
102+
74103
String get name => _type.name ?? _type.element.name;
75104

76105
ModelElement get returnElement {

‎lib/src/html/html_generator_instance.dart‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ class HtmlGeneratorInstance {
9090
generatePackage();
9191

9292
for (var lib in filterNonDocumented(_package.libraries)) {
93-
// if (lib.name != 'extract_messages') continue;
9493
generateLibrary(_package, lib);
9594

9695
for (var clazz in filterNonDocumented(lib.allClasses)) {

‎lib/src/html/template_data.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ class ClassTemplateData extends TemplateData<Class> {
185185
'${library.name} library, for the Dart programming language.';
186186

187187
@override
188-
String get layoutTitle =>
189-
_layoutTitle(clazz.nameWithGenerics, clazz.fullkind, clazz.isDeprecated);
188+
String get layoutTitle => _layoutTitle(
189+
clazz.nameWithLinkedGenerics, clazz.fullkind, clazz.isDeprecated);
190190
@override
191191
List get navLinks => [package, library];
192192
@override

‎lib/src/model.dart‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,6 @@ class Class extends ModelElement
497497
..addAll([]
498498
..addAll(inheritedProperties)
499499
..sort(byName));
500-
501500
return _allInstanceProperties;
502501
}
503502

@@ -4711,11 +4710,20 @@ abstract class SourceCodeMixin {
47114710
abstract class TypeParameters implements Nameable {
47124711
String get nameWithGenerics => '$name$genericParameters';
47134712

4713+
String get nameWithLinkedGenerics => '$name$linkedGenericParameters';
4714+
4715+
bool get hasGenericParameters => typeParameters.isNotEmpty;
4716+
47144717
String get genericParameters {
47154718
if (typeParameters.isEmpty) return '';
47164719
return '&lt;${typeParameters.map((t) => t.name).join(', ')}&gt;';
47174720
}
47184721

4722+
String get linkedGenericParameters {
4723+
if (typeParameters.isEmpty) return '';
4724+
return '<span class="signature">&lt;${typeParameters.map((t) => t.linkedName).join(', ')}&gt;</span>';
4725+
}
4726+
47194727
List<TypeParameter> get typeParameters;
47204728
}
47214729

@@ -4862,11 +4870,28 @@ class TypeParameter extends ModelElement {
48624870
@override
48634871
String get kind => 'type parameter';
48644872

4873+
ElementType get boundType {
4874+
var bound = _typeParameter.bound;
4875+
if (bound != null) {
4876+
ModelElement boundClass =
4877+
new ModelElement.fromElement(bound.element, package);
4878+
return new ElementType(bound, boundClass);
4879+
}
4880+
return null;
4881+
}
4882+
48654883
@override
48664884
String get name {
48674885
var bound = _typeParameter.bound;
4868-
return bound != null
4869-
? '${_typeParameter.name} extends ${bound.name}'
4886+
return _typeParameter.bound != null
4887+
? '${_typeParameter.name} extends ${boundType.nameWithGenerics}'
4888+
: _typeParameter.name;
4889+
}
4890+
4891+
@override
4892+
String get linkedName {
4893+
return _typeParameter.bound != null
4894+
? '${_typeParameter.name} extends ${boundType.linkedName}'
48704895
: _typeParameter.name;
48714896
}
48724897

‎lib/templates/_callable.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<dt id="{{htmlId}}" class="callable{{ #isInherited }} inherited{{ /isInherited}}">
2-
<span class="name{{#isDeprecated}} deprecated{{/isDeprecated}}">{{{linkedName}}}</span><span class="signature">{{{genericParameters}}}(<wbr>{{{ linkedParamsNoMetadata }}})
2+
<span class="name{{#isDeprecated}} deprecated{{/isDeprecated}}">{{{linkedName}}}</span>{{{linkedGenericParameters}}}<span class="signature">(<wbr>{{{ linkedParamsNoMetadata }}})
33
<span class="returntype parameter">&#8594; {{{ linkedReturnType }}}</span>
44
</span>
55
</dt>

‎lib/templates/_head.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
<li><a href="{{href}}">{{name}}</a></li>
3939
{{/navLinks}}
4040
{{#navLinksWithGenerics}}
41-
<li><a href="{{href}}">{{name}}{{{genericParameters}}}</a></li>
41+
<li><a href="{{href}}">{{name}}{{#hasGenericParameters}}<span class="signature">{{{genericParameters}}}</span>{{/hasGenericParameters}}</a></li>
4242
{{/navLinksWithGenerics}}
4343
{{^hasHomepage}}
4444
<li class="self-crumb">{{{ layoutTitle }}}</li>

‎lib/templates/library.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h2>Classes</h2>
3636
<dl>
3737
{{#library.publicClasses}}
3838
<dt id="{{htmlId}}">
39-
<span class="name {{#isDeprecated}}deprecated{{/isDeprecated}}">{{{linkedName}}}</span>
39+
<span class="name {{#isDeprecated}}deprecated{{/isDeprecated}}">{{{linkedName}}}{{{linkedGenericParameters}}}</span>
4040
</dt>
4141
<dd>
4242
{{{ oneLineDoc }}}

‎test/model_test.dart‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1116,21 +1116,21 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11161116
// TODO(jcollins-g): really, these shouldn't be called "parameters" in
11171117
// the span class.
11181118
expect(explicitSetter.linkedReturnType,
1119-
'<span class="parameter" id="explicitSetter=-param-f"><span class="type-annotation">dynamic</span> <span class="parameter-name">Function</span>(<span class="parameter" id="f-param-bar"><span class="type-annotation">int</span>, </span> <span class="parameter" id="f-param-baz"><span class="type-annotation"><a href="fake/Cool-class.html">Cool</a></span>, </span> <span class="parameter" id="f-param-macTruck"><span class="type-annotation">List&lt;int&gt;</span></span>)</span>');
1119+
'<span class="parameter" id="explicitSetter=-param-f"><span class="type-annotation">dynamic</span> <span class="parameter-name">Function</span>(<span class="parameter" id="f-param-bar"><span class="type-annotation">int</span>, </span> <span class="parameter" id="f-param-baz"><span class="type-annotation"><a href="fake/Cool-class.html">Cool</a></span>, </span> <span class="parameter" id="f-param-macTruck"><span class="type-annotation">List<span class="signature">&lt;int&gt;</span></span></span>)</span>');
11201120
});
11211121

11221122
test('parameterized type from field is correctly displayed', () {
11231123
Field aField = TemplatedInterface.instanceProperties
11241124
.singleWhere((f) => f.name == 'aField');
11251125
expect(aField.linkedReturnType,
1126-
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a>&lt;Stream&lt;List&lt;int&gt;&gt;&gt;');
1126+
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a><span class="signature">&lt;Stream<span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>&gt;</span>');
11271127
});
11281128

11291129
test('parameterized type from inherited field is correctly displayed', () {
11301130
Field aInheritedField = TemplatedInterface.inheritedProperties
11311131
.singleWhere((f) => f.name == 'aInheritedField');
11321132
expect(aInheritedField.linkedReturnType,
1133-
'<a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a>&lt;List&lt;int&gt;&gt;');
1133+
'<a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
11341134
});
11351135

11361136
test(
@@ -1140,7 +1140,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11401140
.singleWhere((f) => f.name == 'aGetter')
11411141
.getter;
11421142
expect(aGetter.linkedReturnType,
1143-
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a>&lt;Map&lt;A, List&lt;String&gt;&gt;&gt;');
1143+
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a><span class="signature">&lt;Map<span class="signature">&lt;A, List<span class="signature">&lt;String&gt;</span>&gt;</span>&gt;</span>');
11441144
});
11451145

11461146
test(
@@ -1150,7 +1150,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11501150
.singleWhere((f) => f.name == 'aInheritedGetter')
11511151
.getter;
11521152
expect(aInheritedGetter.linkedReturnType,
1153-
'<a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a>&lt;List&lt;int&gt;&gt;');
1153+
'<a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
11541154
});
11551155

11561156
test(
@@ -1160,11 +1160,11 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11601160
.singleWhere((f) => f.name == 'aInheritedSetter')
11611161
.setter;
11621162
expect(aInheritedSetter.allParameters.first.modelType.linkedName,
1163-
'<a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a>&lt;List&lt;int&gt;&gt;');
1163+
'<a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
11641164
// TODO(jcollins-g): really, these shouldn't be called "parameters" in
11651165
// the span class.
11661166
expect(aInheritedSetter.enclosingCombo.linkedReturnType,
1167-
'<span class="parameter" id="aInheritedSetter=-param-thingToSet"><span class="type-annotation"><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a>&lt;List&lt;int&gt;&gt;</span></span>');
1167+
'<span class="parameter" id="aInheritedSetter=-param-thingToSet"><span class="type-annotation"><a href="ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span></span></span>');
11681168
});
11691169

11701170
test(
@@ -1173,7 +1173,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11731173
Method aMethodInterface = TemplatedInterface.allInstanceMethods
11741174
.singleWhere((m) => m.name == 'aMethodInterface');
11751175
expect(aMethodInterface.linkedReturnType,
1176-
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a>&lt;List&lt;int&gt;&gt;');
1176+
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
11771177
});
11781178

11791179
test(
@@ -1182,7 +1182,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11821182
Method aInheritedMethod = TemplatedInterface.allInstanceMethods
11831183
.singleWhere((m) => m.name == 'aInheritedMethod');
11841184
expect(aInheritedMethod.linkedReturnType,
1185-
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a>&lt;List&lt;int&gt;&gt;');
1185+
'<a href=\"ex/AnotherParameterizedClass-class.html\">AnotherParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
11861186
});
11871187

11881188
test(
@@ -1192,7 +1192,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
11921192
.allInstanceMethods
11931193
.singleWhere((m) => m.name == 'aTypedefReturningMethodInterface');
11941194
expect(aTypedefReturningMethodInterface.linkedReturnType,
1195-
'<a href=\"ex/ParameterizedTypedef.html\">ParameterizedTypedef</a>&lt;List&lt;String&gt;&gt;');
1195+
'<a href=\"ex/ParameterizedTypedef.html\">ParameterizedTypedef</a><span class="signature">&lt;List<span class="signature">&lt;String&gt;</span>&gt;</span>');
11961196
});
11971197

11981198
test(
@@ -1202,7 +1202,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
12021202
.allInstanceMethods
12031203
.singleWhere((m) => m.name == 'aInheritedTypedefReturningMethod');
12041204
expect(aInheritedTypedefReturningMethod.linkedReturnType,
1205-
'<a href=\"ex/ParameterizedTypedef.html\">ParameterizedTypedef</a>&lt;List&lt;int&gt;&gt;');
1205+
'<a href=\"ex/ParameterizedTypedef.html\">ParameterizedTypedef</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
12061206
});
12071207

12081208
test('parameterized types for inherited operator is correctly displayed',
@@ -1211,9 +1211,9 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
12111211
.inheritedOperators
12121212
.singleWhere((m) => m.name == 'operator +');
12131213
expect(aInheritedAdditionOperator.linkedReturnType,
1214-
'<a href=\"ex/ParameterizedClass-class.html\">ParameterizedClass</a>&lt;List&lt;int&gt;&gt;');
1214+
'<a href=\"ex/ParameterizedClass-class.html\">ParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span>');
12151215
expect(aInheritedAdditionOperator.linkedParams(),
1216-
'<span class="parameter" id="+-param-other"><span class="type-annotation"><a href="ex/ParameterizedClass-class.html">ParameterizedClass</a>&lt;List&lt;int&gt;&gt;</span> <span class="parameter-name">other</span></span>');
1216+
'<span class="parameter" id="+-param-other"><span class="type-annotation"><a href="ex/ParameterizedClass-class.html">ParameterizedClass</a><span class="signature">&lt;List<span class="signature">&lt;int&gt;</span>&gt;</span></span> <span class="parameter-name">other</span></span>');
12171217
});
12181218

12191219
test('', () {});
@@ -1279,7 +1279,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
12791279
expect(
12801280
getAFunctionReturningVoid.linkedReturnType,
12811281
equals(
1282-
'Function(<span class="parameter" id="getAFunctionReturningVoid-param-"><span class="type-annotation">T1</span>, </span> <span class="parameter" id="getAFunctionReturningVoid-param-"><span class="type-annotation">T2</span></span>)'));
1282+
'Function<span class="signature">(<span class="parameter" id="getAFunctionReturningVoid-param-"><span class="type-annotation">T1</span>, </span> <span class="parameter" id="getAFunctionReturningVoid-param-"><span class="type-annotation">T2</span></span>)</span>'));
12831283
});
12841284

12851285
test(
@@ -1288,7 +1288,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
12881288
expect(
12891289
getAFunctionReturningBool.linkedReturnType,
12901290
equals(
1291-
'Function&lt;T4&gt;(<span class="parameter" id="getAFunctionReturningBool-param-"><span class="type-annotation">String</span>, </span> <span class="parameter" id="getAFunctionReturningBool-param-"><span class="type-annotation">T1</span>, </span> <span class="parameter" id="getAFunctionReturningBool-param-"><span class="type-annotation">T4</span></span>)'));
1291+
'Function<span class="signature">&lt;T4&gt;</span><span class="signature">(<span class="parameter" id="getAFunctionReturningBool-param-"><span class="type-annotation">String</span>, </span> <span class="parameter" id="getAFunctionReturningBool-param-"><span class="type-annotation">T1</span>, </span> <span class="parameter" id="getAFunctionReturningBool-param-"><span class="type-annotation">T4</span></span>)</span>'));
12921292
});
12931293

12941294
test('has a fully qualified name', () {
@@ -1362,7 +1362,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
13621362

13631363
test('parameter has generics in signature', () {
13641364
expect(testGeneric.parameters[0].modelType.linkedName,
1365-
'Map&lt;String, dynamic&gt;');
1365+
'Map<span class="signature">&lt;String, dynamic&gt;</span>');
13661366
});
13671367

13681368
test('parameter is a function', () {
@@ -1768,7 +1768,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
17681768
expect(
17691769
fieldWithTypedef.linkedReturnType,
17701770
equals(
1771-
'<a href="ex/ParameterizedTypedef.html">ParameterizedTypedef</a>&lt;bool&gt;'));
1771+
'<a href="ex/ParameterizedTypedef.html">ParameterizedTypedef</a><span class="signature">&lt;bool&gt;</span>'));
17721772
});
17731773
});
17741774

@@ -2040,7 +2040,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
20402040
expect(
20412041
aComplexTypedef.linkedReturnType,
20422042
equals(
2043-
'Function(<span class="parameter" id="-param-"><span class="type-annotation">A1</span>, </span> <span class="parameter" id="-param-"><span class="type-annotation">A2</span>, </span> <span class="parameter" id="-param-"><span class="type-annotation">A3</span></span>)'));
2043+
'Function<span class="signature">(<span class="parameter" id="-param-"><span class="type-annotation">A1</span>, </span> <span class="parameter" id="-param-"><span class="type-annotation">A2</span>, </span> <span class="parameter" id="-param-"><span class="type-annotation">A3</span></span>)</span>'));
20442044
expect(
20452045
aComplexTypedef.linkedParamsLines,
20462046
equals(
@@ -2065,7 +2065,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
20652065

20662066
test('linked return type', () {
20672067
expect(t.linkedReturnType, equals('String'));
2068-
expect(generic.linkedReturnType, equals('List&lt;S&gt;'));
2068+
expect(generic.linkedReturnType, equals('List<span class="signature">&lt;S&gt;</span>'));
20692069
});
20702070

20712071
test("name with generics", () {

‎testing/test_package_docs/ex/Animal-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ <h2>Constants</h2>
154154
</dd>
155155
<dt id="values" class="constant">
156156
<span class="name ">values</span>
157-
<span class="signature">&#8594; List&lt;<a href="ex/Animal-class.html">Animal</a>&gt;</span>
157+
<span class="signature">&#8594; List<span class="signature">&lt;<a href="ex/Animal-class.html">Animal</a>&gt;</span></span>
158158
</dt>
159159
<dd>
160160
<p>A constant List of the values in this enum, in order of their declaration.</p>

‎testing/test_package_docs/ex/AnotherParameterizedClass-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
<ol class="breadcrumbs gt-separated dark hidden-xs">
2626
<li><a href="index.html">test_package</a></li>
2727
<li><a href="ex/ex-library.html">ex</a></li>
28-
<li class="self-crumb">class AnotherParameterizedClass&lt;B&gt;</li>
28+
<li class="self-crumb">class AnotherParameterizedClass<span class="signature">&lt;B&gt;</span></li>
2929
</ol>
3030
<div class="self-name">AnotherParameterizedClass</div>
3131
<form class="search navbar-right" role="search">

0 commit comments

Comments
 (0)