Skip to content

FutureOr, void, and dynamic docs improvements #3678

Open
@jakemac53

Description

@jakemac53

This may not be worth fixing, but in the API docs FutureOr is listed as being a "class", even though it isn't actually one. It is weird though because in the code, it is listed as an abstract class (with docs saying it really isn't a class). So presumably that is why it shows up as a class in dartdoc. This could be confusing, because there really are differences between just being a type and being a class.

In thinking about any other weird types like this, void and dynamic came to mind. Neither of these have any documentation at all that I can find, because we didn't do the abstract class workaround just to get docs.

It might be worth creating a new category called just "type", which we could use just to document these, with some special casing in dartdoc?

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3A lower priority bug or feature requesttype-bugIncorrect behavior (everything from a crash to more subtle misbehavior)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions