Flare-Flutter icon indicating copy to clipboard operation
Flare-Flutter copied to clipboard

Update documentation to describe what method params do

Open TytaniumDev opened this issue 6 years ago • 4 comments

I've noticed that a lot of the methods in the generated Dart API docs for Flare-Flutter don't have descriptions about what the parameters actually do. Example: https://pub.dev/documentation/flare_dart/latest/animation_actor_animation/ActorAnimation/apply.html

I had to find the actual documentation for apply in a medium post: https://medium.com/2dimensions/building-a-responsive-house-with-flare-flutter-31af823ba805

The description in the Medium post is excellent, it would be great to put those descriptions directly in the dart docs!

I've noticed this in other places in the docs as well, it'd be good to do an audit?

TytaniumDev avatar Oct 14 '19 17:10 TytaniumDev

/cc @luigi-rosso

jkurtw avatar Oct 14 '19 17:10 jkurtw

We're working on this!

luigi-rosso avatar Oct 16 '19 20:10 luigi-rosso

We recently published our Runtime Manual here. We are continuing to build on it, but it's consolidated a lot of the information we had spread about in our tutorials.

she-who-codes avatar Dec 16 '19 21:12 she-who-codes

Let's keep this issue open to specifically track the Dart API documentation in Flare-Flutter! We still have a long way to go there.

luigi-rosso avatar Dec 17 '19 02:12 luigi-rosso