dartdoc icon indicating copy to clipboard operation
dartdoc copied to clipboard

Doc generated for the immutable annotation could be more helpful

Open HansMuller opened this issue 8 years ago • 3 comments

We've just marked many (more) Flutter classes immutable: https://github.com/flutter/flutter/pull/9462. Hopefully that will make our API easier to understand.

Currently the doc generated for immutable classes just says:

annotations: @immutable

I think it would be helpful if dartdoc provided a short boilerplate statement about what immutable means, and link to a longer discussion about what the implications are, when to use it, etc.

HansMuller avatar Apr 19 '17 16:04 HansMuller

Good idea!

sethladd avatar Apr 19 '17 16:04 sethladd

Can you show an example page of a ~~constructor~~ class annotated with @immutable?

srawlins avatar Jan 03 '19 18:01 srawlins

Curve is one example.

I super agree; annotations should at least be visually higher than the list of Inheritance and Implementers.

srawlins avatar Aug 09 '20 04:08 srawlins