Skip to content

Commit 1f3f739

Browse files
jcollins-gjcollins-g
committed
Add returned type parameter from generic typedef to docs.
1 parent 3b3b1e1 commit 1f3f739

File tree

64 files changed

+316
-20
lines changed

Some content is hidden

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

64 files changed

+316
-20
lines changed

‎lib/src/model.dart‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2699,6 +2699,17 @@ class Typedef extends ModelElement
26992699

27002700
String get fileName => '$name.html';
27012701

2702+
@override
2703+
String get genericParameters {
2704+
if (element is GenericTypeAliasElement) {
2705+
List<TypeParameterElement> genericTypeParameters = (element as GenericTypeAliasElement).function.typeParameters;
2706+
if (genericTypeParameters.isNotEmpty) {
2707+
return '&lt;${genericTypeParameters.map((t) => t.name).join(', ')}&gt;';
2708+
}
2709+
} // else, all types are resolved.
2710+
return '';
2711+
}
2712+
27022713
@override
27032714
String get href => '${canonicalLibrary.dirName}/$fileName';
27042715

@@ -2719,8 +2730,8 @@ class Typedef extends ModelElement
27192730
(element as FunctionTypeAliasElement);
27202731

27212732
List<TypeParameter> get _typeParameters => _typedef.typeParameters.map((f) {
2722-
return new TypeParameter(f, library);
2723-
}).toList();
2733+
return new TypeParameter(f, library);
2734+
}).toList();
27242735
}
27252736

27262737
class TypeParameter extends ModelElement {

‎test/model_test.dart‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1524,6 +1524,11 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
15241524
expect(t.nameWithGenerics, equals('processMessage&lt;T&gt;'));
15251525
expect(generic.nameWithGenerics, equals('NewGenericTypedef&lt;T&gt;'));
15261526
});
1527+
1528+
test("generic parameters", () {
1529+
expect(t.genericParameters, equals(''));
1530+
expect(generic.genericParameters, equals('&lt;S&gt;'));
1531+
});
15271532
});
15281533

15291534
group('Parameter', () {

‎testing/test_package/lib/fake.dart‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,11 @@ thisIsAsync() async => 42;
353353
/// Explicitly returns a Future and is marked async.
354354
Future thisIsAlsoAsync() async => 43;
355355

356+
/// A generic function with a type parameter.
357+
void myGenericFunction<S>(int a, bool b, S c) {
358+
return;
359+
}
360+
356361
/// This is a great thing.
357362
const greatAnnotation = 'great';
358363

‎testing/test_package_docs/fake/Annotation-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
111111
<li><a href="fake/addCallback.html">addCallback</a></li>
112112
<li><a href="fake/addCallback2.html">addCallback2</a></li>
113113
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
114+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
114115
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
115116
<li><a href="fake/paintImage1.html">paintImage1</a></li>
116117
<li><a href="fake/paintImage2.html">paintImage2</a></li>

‎testing/test_package_docs/fake/AnotherInterface-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
111111
<li><a href="fake/addCallback.html">addCallback</a></li>
112112
<li><a href="fake/addCallback2.html">addCallback2</a></li>
113113
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
114+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
114115
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
115116
<li><a href="fake/paintImage1.html">paintImage1</a></li>
116117
<li><a href="fake/paintImage2.html">paintImage2</a></li>

‎testing/test_package_docs/fake/BaseForDocComments-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
111111
<li><a href="fake/addCallback.html">addCallback</a></li>
112112
<li><a href="fake/addCallback2.html">addCallback2</a></li>
113113
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
114+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
114115
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
115116
<li><a href="fake/paintImage1.html">paintImage1</a></li>
116117
<li><a href="fake/paintImage2.html">paintImage2</a></li>

‎testing/test_package_docs/fake/CUSTOM_CLASS-constant.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
104104
<li><a href="fake/addCallback.html">addCallback</a></li>
105105
<li><a href="fake/addCallback2.html">addCallback2</a></li>
106106
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
107+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
107108
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
108109
<li><a href="fake/paintImage1.html">paintImage1</a></li>
109110
<li><a href="fake/paintImage2.html">paintImage2</a></li>

‎testing/test_package_docs/fake/Callback2.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
104104
<li><a href="fake/addCallback.html">addCallback</a></li>
105105
<li><a href="fake/addCallback2.html">addCallback2</a></li>
106106
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
107+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
107108
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
108109
<li><a href="fake/paintImage1.html">paintImage1</a></li>
109110
<li><a href="fake/paintImage2.html">paintImage2</a></li>

‎testing/test_package_docs/fake/Color-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
109109
<li><a href="fake/addCallback.html">addCallback</a></li>
110110
<li><a href="fake/addCallback2.html">addCallback2</a></li>
111111
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
112+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
112113
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
113114
<li><a href="fake/paintImage1.html">paintImage1</a></li>
114115
<li><a href="fake/paintImage2.html">paintImage2</a></li>

‎testing/test_package_docs/fake/ConstantClass-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ <h5><a href="fake/fake-library.html">fake</a></h5>
111111
<li><a href="fake/addCallback.html">addCallback</a></li>
112112
<li><a href="fake/addCallback2.html">addCallback2</a></li>
113113
<li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li>
114+
<li><a href="fake/myGenericFunction.html">myGenericFunction</a></li>
114115
<li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li>
115116
<li><a href="fake/paintImage1.html">paintImage1</a></li>
116117
<li><a href="fake/paintImage2.html">paintImage2</a></li>

0 commit comments

Comments
 (0)