Define some annotations for generating the widget catalog. #10816
Conversation
There was a problem hiding this comment.
You mention "project" here, without defining it.
There was a problem hiding this comment.
What would the definition be? I just meant, like, "Flutter" or "Facebook Flutter Widgets" or whatever.
There was a problem hiding this comment.
library is a defined term. Package is a defined term. Either of those might work?
Or, maybe more simply, "The author of the class defines the categories"... put the responsibility on the author.
(I didn't know if you meant IntelliJ project, or "logical" project, or a user's project?)
There was a problem hiding this comment.
I meant project as in "the team of software engineers and other people working on this code". I can make it say "authors" though.
There was a problem hiding this comment.
"Authors" doesn't work. It makes it sound like whoever invents the class gets to invent the categories. Not sure how to make this clearer. I'll try "team"...
There was a problem hiding this comment.
maybe add "optional", because many API docs will have a sufficient one-line doc in their doc comments. I assume @summary is only required when the existing one-line doc isn't sufficient for generated catalogs, etc.
There was a problem hiding this comment.
Oh, I see you mention Summary is optional in the Summary API docs.
|
this is great, thank you! lgtm |
|
love it lgtm |
3 participants
For #10344.
cc @sethladd