Skip to content

Add annotations to parameter documentation #1450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 13, 2017
Merged

Add annotations to parameter documentation #1450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions lib/src/model.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1880,10 +1880,7 @@ abstract class ModelElement implements Comparable, Nameable, Documentable {
node = node.parent;
}
metadata = node.metadata;
} else if (element.computeNode() is! FormalParameter) {
// TODO(jcollins-g): This is special cased to suppress annotations for
// parameters in constructor documentation. Do we
// want to do this?
} else {
metadata = element.metadata;
}
return annotationsFromMetadata(metadata);
Expand Down
7 changes: 7 additions & 0 deletions test/model_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1627,6 +1627,13 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
expect(params, contains(', </span>'));
});

test('param with annotations', () {
ModelFunction method =
fakeLibrary.functions.firstWhere((f) => f.name == 'paintImage1');
String params = method.linkedParams();
expect(params, contains('@required'));
});

test('param exported in library', () {
var param = paramFromExportLib.parameters[0];
expect(param.name, equals('helper'));
Expand Down
2 changes: 1 addition & 1 deletion testing/test_package_docs/fake/onlyPositionalWithNoDefaultNoType.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ <h5>library fake</h5>
</ol>
</div>
<span class="returntype">void</span>
<span class="name ">onlyPositionalWithNoDefaultNoType</span>(<wbr>[<span class="parameter" id="onlyPositionalWithNoDefaultNoType-param-anything"><span class="parameter-name">anything</span></span> ])
<span class="name ">onlyPositionalWithNoDefaultNoType</span>(<wbr>[<span class="parameter" id="onlyPositionalWithNoDefaultNoType-param-anything"><span>@greatestAnnotation</span> <span class="parameter-name">anything</span></span> ])
</section>
<section class="desc markdown">
<p>A single optional positional param, no type annotation, no default value.</p>
Expand Down
2 changes: 1 addition & 1 deletion testing/test_package_docs/fake/paintImage1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h5>library fake</h5>

<section class="multi-line-signature">
<span class="returntype">void</span>
<span class="name ">paintImage1</span>(<wbr>{<span class="parameter" id="paintImage1-param-canvas"><span class="type-annotation">String</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paintImage1-param-rect"><span class="type-annotation">int</span> <span class="parameter-name">rect</span>, </span> <span class="parameter" id="paintImage1-param-image"><span class="type-annotation"><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> <span class="parameter-name">image</span>, </span> <span class="parameter" id="paintImage1-param-colorFilter"><span class="type-annotation"><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> <span class="parameter-name">colorFilter</span>, </span> <span class="parameter" id="paintImage1-param-repeat"><span class="type-annotation">String</span> <span class="parameter-name">repeat</span>: <span class="default-value">LongFirstLine.THING</span></span> })
<span class="name ">paintImage1</span>(<wbr>{<span class="parameter" id="paintImage1-param-canvas"><span>@required</span> <span class="type-annotation">String</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paintImage1-param-rect"><span>@required</span> <span class="type-annotation">int</span> <span class="parameter-name">rect</span>, </span> <span class="parameter" id="paintImage1-param-image"><span>@required</span> <span class="type-annotation"><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> <span class="parameter-name">image</span>, </span> <span class="parameter" id="paintImage1-param-colorFilter"><span class="type-annotation"><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> <span class="parameter-name">colorFilter</span>, </span> <span class="parameter" id="paintImage1-param-repeat"><span class="type-annotation">String</span> <span class="parameter-name">repeat</span>: <span class="default-value">LongFirstLine.THING</span></span> })
</section>
<section class="desc markdown">
<p>Paints an image into the given rectangle in the canvas.</p>
Expand Down
2 changes: 1 addition & 1 deletion testing/test_package_docs/fake/paintImage2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h5>library fake</h5>

<section class="multi-line-signature">
<span class="returntype">void</span>
<span class="name ">paintImage2</span>(<wbr><span class="parameter" id="paintImage2-param-fooParam"><span class="type-annotation">String</span> <span class="parameter-name">fooParam</span>, [</span> <span class="parameter" id="paintImage2-param-canvas"><span class="type-annotation">String</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paintImage2-param-rect"><span class="type-annotation">int</span> <span class="parameter-name">rect</span>, </span> <span class="parameter" id="paintImage2-param-image"><span class="type-annotation"><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> <span class="parameter-name">image</span>, </span> <span class="parameter" id="paintImage2-param-colorFilter"><span class="type-annotation"><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> <span class="parameter-name">colorFilter</span>, </span> <span class="parameter" id="paintImage2-param-repeat"><span class="type-annotation">String</span> <span class="parameter-name">repeat</span> = <span class="default-value">LongFirstLine.THING</span></span> ])
<span class="name ">paintImage2</span>(<wbr><span class="parameter" id="paintImage2-param-fooParam"><span class="type-annotation">String</span> <span class="parameter-name">fooParam</span>, [</span> <span class="parameter" id="paintImage2-param-canvas"><span>@required</span> <span class="type-annotation">String</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paintImage2-param-rect"><span>@required</span> <span class="type-annotation">int</span> <span class="parameter-name">rect</span>, </span> <span class="parameter" id="paintImage2-param-image"><span>@required</span> <span class="type-annotation"><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> <span class="parameter-name">image</span>, </span> <span class="parameter" id="paintImage2-param-colorFilter"><span class="type-annotation"><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> <span class="parameter-name">colorFilter</span>, </span> <span class="parameter" id="paintImage2-param-repeat"><span class="type-annotation">String</span> <span class="parameter-name">repeat</span> = <span class="default-value">LongFirstLine.THING</span></span> ])
</section>
<section class="desc markdown">
<p>Paints an image into the given rectangle in the canvas.</p>
Expand Down