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

[docs] Improve documentation and add dartdoc #147

Closed
1 of 2 tasks
aagarwal1012 opened this issue Nov 5, 2020 · 3 comments
Closed
1 of 2 tasks

[docs] Improve documentation and add dartdoc #147

aagarwal1012 opened this issue Nov 5, 2020 · 3 comments
Labels
documentation documentation enhancement New feature or request

Comments

@aagarwal1012
Copy link
Owner

aagarwal1012 commented Nov 5, 2020

  • Check/add/update documentation for all public classes and method in the package. Documentation issue address by the Flutter community are mentioned below:
  FadeAnimatedTextKit: fade.dart:5:1
  createState: fade.dart:107:3
  TextLiquidFill: text_liquid_fill.dart:4:1
  createState: text_liquid_fill.dart:71:3
  WavePainter: text_liquid_fill.dart:167:1
  paint: text_liquid_fill.dart:183:3
  shouldRepaint: text_liquid_fill.dart:209:3
  TypewriterAnimatedTextKit: typewriter.dart:6:1
  createState: typewriter.dart:106:3
  ColorizeAnimatedTextKit: colorize.dart:4:1
  createState: colorize.dart:91:3
  RotateAnimatedTextKit: rotate.dart:4:1
  createState: rotate.dart:111:3
  TyperAnimatedTextKit: typer.dart:6:1
  createState: typer.dart:91:3
  WavyAnimatedTextKit: wavy.dart:5:1
  createState: wavy.dart:62:3
  ScaleAnimatedTextKit: scale.dart:5:1
  createState: scale.dart:114:3
  • Add dartdoc and host the HTML documentation on github pages.

cc: @awhitford

@aagarwal1012 aagarwal1012 added enhancement New feature or request documentation documentation labels Nov 5, 2020
@aagarwal1012
Copy link
Owner Author

@awhitford, hosting dartdoc is just a suggestion for us to make better documentation, it is not necessary for now.

@awhitford
Copy link
Collaborator

Generating dartdoc locally is trivial, and you get the API on pub.dev from a publish, so I do not recommend adding the complexity of gh-pages because I expect people will simply go to pub.dev (or rely on their IDE).

Repository owner deleted a comment from awhitford Nov 6, 2020
@aagarwal1012
Copy link
Owner Author

I agree with your argument -- let's close this issue for now.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants