question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support for DartDoc macros

See original GitHub issue

When jumping to the definition of a function or property within the flutter framework I often see something like the following:

  /// {@macro flutter.widgets.widgetsApp.color}
  final Color color;

  /// {@macro flutter.widgets.widgetsApp.locale}
  final Locale locale;

It would be great if IntelliJ would offer some sort of support for these DartDoc macros. I’d love it if IntelliJ would just show inline what the macro is referencing. Or at least provide a link to the referenced location.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:10
  • Comments:11 (7 by maintainers)

github_iconTop GitHub Comments

2reactions
xstercommented, Aug 23, 2018

Or just go-to-definition clicking a @macro going to the @template would be nice too.

1reaction
devoncarewcommented, May 8, 2019

This functionality has been rolled into the analysis server - dartdoc hovers in IDEs now show the in-lined content from macros.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Support for DartDoc macros (Android Studio) #44774 - GitHub
Support for DartDoc macros (Android Studio) #44774 ... I can confirm that the server doesn't provide navigation data for macros in comments.
Read more >
How do I create DartDoc Macros/Templates in Dart and Flutter?
You can create templates and use them as macros using dartdoc , which is the default API documentation package that comes with Flutter....
Read more >
dartdoc | Dart Package - Pub.dev
Use dart doc to generate HTML documentation for your Dart package. ... Run dart help doc to see the available command-line options.
Read more >
dartdoc
Use dartdoc to generate HTML documentaton for your Dart package. ... You can specify “macros”, i.e. reusable pieces of documentation.
Read more >
Effective Dart: Documentation - Dart programming language
int get length => ... For historical reasons, dart doc supports two syntaxes of doc comments: /// (“C# style”) and ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found