Skip to content

{@template} docs not showing up in base class #1812

@tvolkert

Description

@tvolkert

Flutter's WidgetsApp.localizationsDelegates uses {@template} to set up a reusable documentation block for subclasses:

  /// {@template flutter.widgets.widgetsApp.localizationsDelegates}
  /// The delegates for this app's [Localizations] widget.
  ///
  /// The delegates collectively define all of the localized resources
  /// for this application's [Localizations] widget.
  /// {@endtemplate}
  final Iterable<LocalizationsDelegate<dynamic>> localizationsDelegates;

The documentation that's produced for the base class is empty: https://docs.flutter.io/flutter/widgets/WidgetsApp/localizationsDelegates.html. Note that subclasses that use the {@macro} do get the correct documentation inserted.

It seems that {@template} documentation blocks should still show in the generated documentation.

/cc @jcollins-g

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2A bug or feature request we're likely to work ontype-enhancementA request for a change that isn't a bug

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions