diff --git a/lib/src/render/parameter_renderer.dart b/lib/src/render/parameter_renderer.dart index 7bd55493b4..ee8d78192a 100644 --- a/lib/src/render/parameter_renderer.dart +++ b/lib/src/render/parameter_renderer.dart @@ -22,7 +22,7 @@ class ParameterRendererHtmlList extends ParameterRendererHtml { /// Render HTML suitable for a single, wrapped line. class ParameterRendererHtml extends ParameterRenderer { @override - String listItem(String listItem) => '${listItem}<wbr>'; + String listItem(String listItem) => '${listItem}'; @override String orderedList(String listItems) => listItems; @override diff --git a/test/model_special_cases_test.dart b/test/model_special_cases_test.dart index 73b80b7a0a..d469184d50 100644 --- a/test/model_special_cases_test.dart +++ b/test/model_special_cases_test.dart @@ -209,7 +209,7 @@ void main() { 'Map<span class="signature"><<wbr><span class="type-parameter">T?</span>, <span class="type-parameter">String?</span>></span>')); expect(aComplexSetterOnlyType.linkedReturnType, equals( // TODO(jcollins-g): fix wrong span class for setter-only return type (#2226) - '<span class="parameter" id="aComplexSetterOnlyType=-param-value"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">Map<span class="signature"><<wbr><span class="type-parameter">T?</span>, <span class="type-parameter">String?</span>></span>?</span>></span></span></span><wbr>')); + '<span class="parameter" id="aComplexSetterOnlyType=-param-value"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">Map<span class="signature"><<wbr><span class="type-parameter">T?</span>, <span class="type-parameter">String?</span>></span>?</span>></span></span></span>')); }); test('simple nullable elements are detected and rendered correctly', () { @@ -231,7 +231,7 @@ void main() { expect( methodWithNullables.linkedParams, equals( - '<span class="parameter" id="methodWithNullables-param-foo"><span class="type-annotation">String?</span> <span class="parameter-name">foo</span></span><wbr>')); + '<span class="parameter" id="methodWithNullables-param-foo"><span class="type-annotation">String?</span> <span class="parameter-name">foo</span></span>')); expect(methodWithNullables.linkedReturnType, equals('int?')); expect( initialized.linkedReturnType, @@ -240,7 +240,7 @@ void main() { expect( operatorStar.linkedParams, equals( - '<span class="parameter" id="*-param-nullableOther"><span class="type-annotation"><a href="%%__HTMLBASE_dartdoc_internal__%%nullable_elements/NullableMembers-class.html">NullableMembers</a>?</span> <span class="parameter-name">nullableOther</span></span><wbr>')); + '<span class="parameter" id="*-param-nullableOther"><span class="type-annotation"><a href="%%__HTMLBASE_dartdoc_internal__%%nullable_elements/NullableMembers-class.html">NullableMembers</a>?</span> <span class="parameter-name">nullableOther</span></span>')); }); }, skip: (!_nullSafetyExperimentAllowed.allows(_platformVersion) && diff --git a/test/model_test.dart b/test/model_test.dart index 88c37b5e21..93abe81476 100644 --- a/test/model_test.dart +++ b/test/model_test.dart @@ -2266,7 +2266,7 @@ void main() { ParameterRendererHtml() .renderLinkedParams(paramOfFutureOrNull.parameters), equals( - '<span class="parameter" id="paramOfFutureOrNull-param-future"><span class="type-annotation">FutureOr<span class="signature"><<wbr><span class="type-parameter">Null</span>></span></span> <span class="parameter-name">future</span></span><wbr>')); + '<span class="parameter" id="paramOfFutureOrNull-param-future"><span class="type-annotation">FutureOr<span class="signature"><<wbr><span class="type-parameter">Null</span>></span></span> <span class="parameter-name">future</span></span>')); }); test('function with a bound type to FutureOr', () { @@ -2309,7 +2309,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, params, '<span class="parameter" id="addCallback-param-callback">' '<span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}fake/VoidCallback.html">VoidCallback</a></span> ' - '<span class="parameter-name">callback</span></span><wbr>'); + '<span class="parameter-name">callback</span></span>'); function = fakeLibrary.functions.firstWhere((f) => f.name == 'addCallback2'); @@ -2318,7 +2318,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, params, '<span class="parameter" id="addCallback2-param-callback">' '<span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}fake/Callback2.html">Callback2</a></span> ' - '<span class="parameter-name">callback</span></span><wbr>'); + '<span class="parameter-name">callback</span></span>'); }); test('supports generic methods', () { @@ -2329,8 +2329,13 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, test('can resolve functions as parameters', () { var params = ParameterRendererHtml() .renderLinkedParams(doAComplicatedThing.parameters); - expect(params, - '<span class="parameter" id="doAComplicatedThing-param-x"><span class="type-annotation">int</span> <span class="parameter-name">x</span>, </span><wbr><span class="parameter" id="doAComplicatedThing-param-doSomething">{<span class="type-annotation">void</span> <span class="parameter-name">doSomething</span>(<span class="parameter" id="param-aThingParameter"><span class="type-annotation">int</span> <span class="parameter-name">aThingParameter</span>, </span><wbr><span class="parameter" id="param-anotherThing"><span class="type-annotation">String</span> <span class="parameter-name">anotherThing</span></span><wbr>), </span><wbr><span class="parameter" id="doAComplicatedThing-param-doSomethingElse"><span class="type-annotation">void</span> <span class="parameter-name">doSomethingElse</span>(<span class="parameter" id="param-aThingParameter"><span class="type-annotation">int</span> <span class="parameter-name">aThingParameter</span>, </span><wbr><span class="parameter" id="param-somethingElse"><span class="type-annotation">double</span> <span class="parameter-name">somethingElse</span></span><wbr>)}</span><wbr>'); + expect( + params, + '<span class="parameter" id="doAComplicatedThing-param-x"><span class="type-annotation">int</span> <span class="parameter-name">x</span>, </span>' + '<span class="parameter" id="doAComplicatedThing-param-doSomething">{<span class="type-annotation">void</span> <span class="parameter-name">doSomething</span>(<span class="parameter" id="param-aThingParameter"><span class="type-annotation">int</span> <span class="parameter-name">aThingParameter</span>, </span>' + '<span class="parameter" id="param-anotherThing"><span class="type-annotation">String</span> <span class="parameter-name">anotherThing</span></span>), </span>' + '<span class="parameter" id="doAComplicatedThing-param-doSomethingElse"><span class="type-annotation">void</span> <span class="parameter-name">doSomethingElse</span>(<span class="parameter" id="param-aThingParameter"><span class="type-annotation">int</span> <span class="parameter-name">aThingParameter</span>, </span>' + '<span class="parameter" id="param-somethingElse"><span class="type-annotation">double</span> <span class="parameter-name">somethingElse</span></span>)}</span>'); }); }); @@ -2349,8 +2354,11 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, .singleWhere((f) => f.name == 'explicitSetter'); // TODO(jcollins-g): really, these shouldn't be called "parameters" in // the span class. - expect(explicitSetter.linkedReturnType, - '<span class="parameter" id="explicitSetter=-param-f"><span class="type-annotation">dynamic</span> <span class="parameter-name">Function</span>(<span class="parameter" id="param-bar"><span class="type-annotation">int</span>, </span><wbr><span class="parameter" id="param-baz"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}fake/Cool-class.html">Cool</a></span>, </span><wbr><span class="parameter" id="param-macTruck"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">int</span>></span></span></span><wbr>)</span><wbr>'); + expect( + explicitSetter.linkedReturnType, + '<span class="parameter" id="explicitSetter=-param-f"><span class="type-annotation">dynamic</span> <span class="parameter-name">Function</span>(<span class="parameter" id="param-bar"><span class="type-annotation">int</span>, </span>' + '<span class="parameter" id="param-baz"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}fake/Cool-class.html">Cool</a></span>, </span>' + '<span class="parameter" id="param-macTruck"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">int</span>></span></span></span>)</span>'); }); test('parameterized type from field is correctly displayed', () { @@ -2398,7 +2406,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, // TODO(jcollins-g): really, these shouldn't be called "parameters" in // the span class. expect(aInheritedSetter.enclosingCombo.linkedReturnType, - '<span class="parameter" id="aInheritedSetter=-param-thingToSet"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a><span class="signature"><<wbr><span class="type-parameter">List<span class="signature"><<wbr><span class="type-parameter">int</span>></span></span>></span></span></span><wbr>'); + '<span class="parameter" id="aInheritedSetter=-param-thingToSet"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/AnotherParameterizedClass-class.html">AnotherParameterizedClass</a><span class="signature"><<wbr><span class="type-parameter">List<span class="signature"><<wbr><span class="type-parameter">int</span>></span></span>></span></span></span>'); }); test( @@ -2446,7 +2454,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, expect( ParameterRendererHtml() .renderLinkedParams(aInheritedAdditionOperator.parameters), - '<span class="parameter" id="+-param-other"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/ParameterizedClass-class.html">ParameterizedClass</a><span class="signature"><<wbr><span class="type-parameter">List<span class="signature"><<wbr><span class="type-parameter">int</span>></span></span>></span></span> <span class="parameter-name">other</span></span><wbr>'); + '<span class="parameter" id="+-param-other"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/ParameterizedClass-class.html">ParameterizedClass</a><span class="signature"><<wbr><span class="type-parameter">List<span class="signature"><<wbr><span class="type-parameter">int</span>></span></span>></span></span> <span class="parameter-name">other</span></span>'); }); test('', () {}); @@ -2509,7 +2517,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, expect( getAFunctionReturningVoid.linkedReturnType, equals( - 'void Function<span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">T1</span>, </span><wbr><span class="parameter" id="param-"><span class="type-annotation">T2</span></span><wbr>)</span>')); + 'void Function<span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">T1</span>, </span><span class="parameter" id="param-"><span class="type-annotation">T2</span></span>)</span>')); }); test( @@ -2518,7 +2526,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, expect( getAFunctionReturningBool.linkedReturnType, equals( - 'bool Function<<wbr><span class="type-parameter">T4</span>><span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">String</span>, </span><wbr><span class="parameter" id="param-"><span class="type-annotation">T1</span>, </span><wbr><span class="parameter" id="param-"><span class="type-annotation">T4</span></span><wbr>)</span>')); + 'bool Function<<wbr><span class="type-parameter">T4</span>><span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">String</span>, </span><span class="parameter" id="param-"><span class="type-annotation">T1</span>, </span><span class="parameter" id="param-"><span class="type-annotation">T4</span></span>)</span>')); }); test('has a fully qualified name', () { @@ -3125,11 +3133,11 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, // TODO(jcollins-g): after analyzer 0.39.5 change to 'num' in first // group. matches(RegExp( - r'(dynamic|num) Function<span class="signature">\(<span class="parameter" id="param-a"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">num</span>></span></span> <span class="parameter-name">a</span></span><wbr>\)</span>'))); + r'(dynamic|num) Function<span class="signature">\(<span class="parameter" id="param-a"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">num</span>></span></span> <span class="parameter-name">a</span></span>\)</span>'))); expect( importantComputations.linkedReturnType, matches(RegExp( - r'Map<span class="signature"><<wbr><span class="type-parameter">int</span>, <span class="type-parameter">(dynamic|num) Function<span class="signature">\(<span class="parameter" id="param-a"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">num</span>></span></span> <span class="parameter-name">a</span></span><wbr>\)</span></span>></span>'))); + r'Map<span class="signature"><<wbr><span class="type-parameter">int</span>, <span class="type-parameter">(dynamic|num) Function<span class="signature">\(<span class="parameter" id="param-a"><span class="type-annotation">List<span class="signature"><<wbr><span class="type-parameter">num</span>></span></span> <span class="parameter-name">a</span></span>\)</span></span>></span>'))); }); test( @@ -3138,7 +3146,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, expect( complicatedReturn.linkedReturnType, equals( - '<a href="${HTMLBASE_PLACEHOLDER}fake/ATypeTakingClass-class.html">ATypeTakingClass</a><span class="signature"><<wbr><span class="type-parameter">String Function<span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">int</span></span><wbr>)</span></span>></span>')); + '<a href="${HTMLBASE_PLACEHOLDER}fake/ATypeTakingClass-class.html">ATypeTakingClass</a><span class="signature"><<wbr><span class="type-parameter">String Function<span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">int</span></span>)</span></span>></span>')); }); test('@nodoc on simple property works', () { @@ -3423,7 +3431,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, ParameterRendererHtml().renderLinkedParams(aVoidParameter.parameters, showMetadata: true, showNames: true), equals( - '<span class="parameter" id="aVoidParameter-param-p1"><span class="type-annotation">Future<span class="signature"><<wbr><span class="type-parameter">void</span>></span></span> <span class="parameter-name">p1</span></span><wbr>')); + '<span class="parameter" id="aVoidParameter-param-p1"><span class="type-annotation">Future<span class="signature"><<wbr><span class="type-parameter">void</span>></span></span> <span class="parameter-name">p1</span></span>')); }); test('a class that extends Future<void>', () { @@ -3505,7 +3513,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, expect( ParameterRendererHtml().renderLinkedParams(theConstructor.parameters), equals( - '<span class="parameter" id="-param-x"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/ParameterizedTypedef.html">ParameterizedTypedef</a><span class="signature"><<wbr><span class="type-parameter">double</span>></span></span> <span class="parameter-name">x</span></span><wbr>')); + '<span class="parameter" id="-param-x"><span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/ParameterizedTypedef.html">ParameterizedTypedef</a><span class="signature"><<wbr><span class="type-parameter">double</span>></span></span> <span class="parameter-name">x</span></span>')); }); test('anonymous nested functions inside typedefs are handled', () { @@ -3522,7 +3530,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, expect( aComplexTypedef.linkedReturnType, equals( - 'void Function<span class="signature">(<span class="parameter" id="param-"><span class="type-annotation">A1</span>, </span><wbr><span class="parameter" id="param-"><span class="type-annotation">A2</span>, </span><wbr><span class="parameter" id="param-"><span class="type-annotation">A3</span></span><wbr>)</span>')); + 'void 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>')); expect( aComplexTypedef.linkedParamsLines, equals( @@ -3690,7 +3698,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans, params, equals('<span class="parameter" id="methodWithTypedefParam-param-p">' '<span class="type-annotation"><a href="${HTMLBASE_PLACEHOLDER}ex/processMessage.html">processMessage</a></span> ' - '<span class="parameter-name">p</span></span><wbr>')); + '<span class="parameter-name">p</span></span>')); }); });