-
Notifications
You must be signed in to change notification settings - Fork 124
Request to group concepts together, across libraries #1353
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Would like to know more here. This sounds like you want something (A comment? A separate file?) that declares a "concept" with a description or similar. The closest thing dartdoc does similar to this is the top level index for a package, so my first inclination would be to generate something that looks like that. If we see this concept referenced via a decorator or similar for a particular identifier, cross-link that identifier with the concept's top level page. You could sort of do that now with an arbitrary decorator you declare for the concept, say @MyConcept. And in @MyConcept's doc you could describe the concept. But that would only link one direction right now, I think. |
@sethladd, @InMatrix - can you give @jcollins-g a sketch of what you are hoping we can do here? |
We would love to be able to annotate an API's category and subcategory in its source code and generate a file similar to the hand-crafted widgets.json, which backs the widget catalog. Some of the categories are across library boundaries such as "layout models." |
@sethladd did you envision other use of the categorization mechanism discussed here? On second thought, keeping widgets.json updated is not too bad. So I'm not sure if it's worth pursuing a more sophisticated solution. |
Ah. So, you're not actually looking for a front-page for the concept, but rather for dartdoc to generate jsons using the custom annotation you described? |
@Hixie if you can add a category and subcategory annotation to widgets, we can extract out a beautiful widget catalog and look at dartdoc organization options, as @InMatrix suggests. I opened flutter/flutter#10344 to ask for a solution in the source code. From there, we can look at display options. |
This feature will be especially useful to show animation-related widgets in a single place. They are currently scattered in the Animation library, the Material library, and the Widget library. |
This is actually complete as of a couple versions ago. |
Related to flutter/flutter#8906
We'd like to:
The text was updated successfully, but these errors were encountered: