Skip to content

Constructor property setters should include documentation for those properties #2617

Open
@tvolkert

Description

@tvolkert

Consider the following constructor:

https://api.flutter.dev/flutter/material/MaterialApp/MaterialApp.html

It looks like this in the API docs:

Screen Shot 2021-04-12 at 9 58 28 AM

None of the parameters to the constructor are documented... despite every single one of the corresponding member variables being documented (e.g. https://api.flutter.dev/flutter/material/MaterialApp/localizationsDelegates.html).

Our dartdocs should make it clear that these constructor parameters are setting the corresponding member variables and either (a) provide a hyperlink to the documentation for the corresponding member variables, or (b) inline those docs in a way that would be easy for a human to parse.

Note that this is particularly bad for new developers, because they don't necessarily know that these constructor parameters even map to member variables that [might] have their own docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2A bug or feature request we're likely to work onarea-web-designSomething a web designer interested in helping could do.customer-flutterIssues originating from important to Fluttertype-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