Skip to content

Commit ed35615

Browse files
authored
Make templates appear where they are defined. (#1816)
* Make templates appear where they are defined. * Rebuild test package docs * Test tweak
1 parent d9ec5ce commit ed35615

File tree

9 files changed

+12
-11
lines changed

9 files changed

+12
-11
lines changed

lib/src/model.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4251,7 +4251,7 @@ abstract class ModelElement extends Canonicalization
42514251
multiLine: true);
42524252
return rawDocs.replaceAllMapped(templateRegExp, (match) {
42534253
packageGraph._addMacro(match[1].trim(), match[2].trim());
4254-
return "";
4254+
return "{@macro ${match[1].trim()}}";
42554255
});
42564256
}
42574257

test/model_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -719,7 +719,7 @@ void main() {
719719

720720
test("renders a macro within the same comment where it's defined", () {
721721
expect(withMacro.documentation,
722-
equals("Macro method\n\n\nFoo macro content\nMore docs"));
722+
equals("Macro method\n\nFoo macro content\nMore docs"));
723723
});
724724

725725
test("renders a macro in another method, not the same where it's defined",

testing/test_package/lib/example.dart

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,6 @@ class Dog implements Cat, E {
337337
/// Foo macro content
338338
/// {@endtemplate}
339339
///
340-
/// {@macro foo}
341340
/// More docs
342341
void withMacro() {}
343342

testing/test_package_docs/ex/ToolUser/invokeTool.html

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testing/test_package_docs/ex/ToolUser/invokeToolNoInput.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testing/test_package_docs/fake/MacrosFromAccessors-class.html

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testing/test_package_docs_dev/ex/ToolUser/invokeTool.html

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testing/test_package_docs_dev/ex/ToolUser/invokeToolNoInput.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testing/test_package_docs_dev/fake/MacrosFromAccessors-class.html

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)