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

Add JSDocs to new API in 2.0 #1001

Closed
dsparacio opened this issue Jan 12, 2016 · 7 comments
Closed

Add JSDocs to new API in 2.0 #1001

dsparacio opened this issue Jan 12, 2016 · 7 comments
Assignees
@dsparacio
Labels
Documentation
Milestone
2.0.0

Comments

@dsparacio
Copy link
Contributor

New API in MediaPlayer, any objects with getters in mediaplayer, all events in MediaPlayerEvents and all metrics objects that are accessible at player level.
@dsparacio dsparacio added this to the 2.0.0 milestone Jan 12, 2016
@dsparacio dsparacio self-assigned this Jan 12, 2016
@bwidtmann
Copy link
Contributor

I will start with all the scheduling and buffering values in a short.

@dsparacio
Copy link
Contributor Author

Thanks @bwidtmann

@dsparacio
Copy link
Contributor Author

To all contributors, If you have added a public API (most likely MediaPlayer) Please try to add sufficient JSDocs to the doc stub above the method if you have not already done so. This will be a huge help.

Thank You

dsparacio pushed a commit to dsparacio/dash.js that referenced this issue Feb 9, 2016
Adding API JSDocs to MediaPlayer. Partial fix for Dash-Industry-Forum…
725293f 
…#1001. Still need event docs at min.
@dsparacio
Copy link
Contributor Author

We need to add more docs and refine in next release. I have added all i can add for now. I will move this issue to 2.1 milestone once we release.

dsparacio pushed a commit that referenced this issue Feb 9, 2016
Merge pull request #1147 from AkamaiDASH/development
070936b 
Fix for #1001
@bwidtmann
Copy link
Contributor

@AkamaiDASH I have checked your docs and completed them with the buffer pruning values in this PR: #1148

@dsparacio
Copy link
Contributor Author

@bwidtmann thank you!

@dsparacio
Copy link
Contributor Author

API for 2.0 has been documented. Will open a new JSDoc for 2.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dsparacio dsparacio

Labels
Documentation
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
2 participants
@bwidtmann @dsparacio