Repository navigation
Class overview contains {@template xxx} of properties/methods #2272
Description
When the doc comment of a property or method within a class starts with {@template fff}, that string appears in the overview doc of the enclosing class:
Activity
srawlins commentedon Jul 23, 2020
Interesting that it doesn't show up in the property's individual page.
Can you link me to the source code of SliverFixedExtentList?
goderbauer commentedon Jul 23, 2020
Here's the source: https://github.com/flutter/flutter/blob/b58c3f0852863417b482147527e8b694243f3b2f/packages/flutter/lib/src/widgets/sliver.dart#L871
goderbauer commentedon Jul 23, 2020
There're about 15 occurrences of this in the Flutter docs. It also happens with library overview pages: https://master-api.flutter.dev/flutter/cupertino/cupertino-library.html (search for
@template).srawlins commentedon Jul 23, 2020
Do you expect the documentation to be the text inside
{@template} ... {@endtemplate}, as if it were rendered with@macro?goderbauer commentedon Jul 23, 2020
Yes, I would expect the class/library overview to show an excerpt of what's inside the template directive. For the SliverFixedExtend example from above, I would expect it to just show: "The delegate that provides the children for this widget."
srawlins commentedon Jul 23, 2020
Excellent. Thanks.
jcollins-g commentedon Oct 7, 2020
This is a tricky one. This case appears to be well tested in dartdoc and behaves appropriately in similarly constructed test scenarios. So there's something special about these handful of cases that is failing here.
srawlins commentedon Oct 7, 2020
Yes! I too failed to reproduce with a unit test. Something about inherited methods, inheritance between libraries... inheritance across the public/private boundary? Indirect inheritance?
jcollins-g commentedon Oct 7, 2020
@srawlins now that I have the debugger working I'll dig into this more tomorrow with the actual flutter code and see if I can step through it in debug mode to see what's happening.