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.

Sign up for GitHub

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

Jump to bottom

Documentation #12

Open
1 of 5 tasks
andreasgangso opened this issue Aug 9, 2023 · 0 comments
Open
1 of 5 tasks

Documentation #12

andreasgangso opened this issue Aug 9, 2023 · 0 comments
Assignees
@andreasgangso

Comments

@andreasgangso
Copy link
Member

andreasgangso commented Aug 9, 2023 •
edited
Loading

  • Comment all API functions, at the very least in BccmPlayerController.
  • Move everything from README.md to doc/
  • Clean up top level exports, some folders like theme/ should be in lib/ and exported via bccm_player.dart for example. This also cleans up the API reference docs.
  • Document a few common scenarios as examples
  • Document how to customize the player (theming and custom ui)
@andreasgangso andreasgangso added the documentation Improvements or additions to documentation label Aug 9, 2023
@andreasgangso andreasgangso self-assigned this Aug 9, 2023
@mulundapm mulundapm removed the documentation Improvements or additions to documentation label Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andreasgangso andreasgangso

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@andreasgangso @mulundapm