Search code examples
dartdartdoc

dart show documentation from another method in another file


Is it possible to show the documentation of a function in the documentation of another function residing in a different file? Macros are only valid in their own file.

In the Flutter source code, they use something like this, but it does not seem to have any effect:

/// {@macro flutter.widgets.editableText.keyboardType}

Solution

  • Macro docs is what you are looking for. They are already explained here but in summary allows you do exactly what you want: copy a documentation from a place to somewhere else without re-write.