Skip to content
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

Support @macro on documentation comments #1444

Closed
gabrc52 opened this issue Feb 2, 2019 · 2 comments
Closed

Support @macro on documentation comments #1444

gabrc52 opened this issue Feb 2, 2019 · 2 comments
Labels
in editor Relates to code editing or language features is enhancement
Milestone

Comments

@gabrc52
Copy link

gabrc52 commented Feb 2, 2019

For example, MaterialApp.color, should show

The primary color to use for the application in the operating system
interface.

For example, on Android this is the color used for the application in the
application switcher.

instead of

{@macro flutter.widgets.widgetsApp.color}

See https://github.com/dart-lang/dartdoc#macros

@DanTup DanTup added the blocked on dart / flutter Requires a change in Dart or Flutter to progress label Feb 3, 2019
@DanTup
Copy link
Member

DanTup commented Feb 3, 2019

It's not currently possible to resolve these from the editor, though the {@macro text should at least be stripped out (see #1420). If you're still seeing the macro text in the latest version, let me know and I'll take another look.

Long-term we need to find a better way to handle this, but there sadly isn't a quick fix.

@DanTup DanTup added this to the Backlog milestone Feb 3, 2019
@DanTup DanTup added is enhancement in editor Relates to code editing or language features labels Feb 3, 2019
@DanTup DanTup modified the milestones: Backlog, v2.26.0 Apr 3, 2019
@DanTup
Copy link
Member

DanTup commented Apr 8, 2019

This has been resolved in vNext when using a new enough version of the SDKs. It's really an SDK fix, however it currently only enables with SuggestionSets, which are on by default in v2.26.

Screenshot 2019-04-08 at 10 40 15 am (2)

Screenshot 2019-04-08 at 10 41 01 am

@DanTup DanTup removed the blocked on dart / flutter Requires a change in Dart or Flutter to progress label Apr 8, 2019
@DanTup DanTup closed this as completed Apr 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in editor Relates to code editing or language features is enhancement
Projects
None yet
Development

No branches or pull requests

2 participants