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

Added missing @exportDoc annotations #1208

Merged
merged 2 commits into from
Jan 1, 2018
Merged

Added missing @exportDoc annotations #1208

merged 2 commits into from
Jan 1, 2018

Conversation

mrlika
Copy link
Contributor

@mrlika mrlika commented Dec 26, 2017

Those externs are referenced in other parts of documentation

@mrlika
Copy link
Contributor Author

mrlika commented Dec 26, 2017 •
edited
Loading

Also typo should be fixed in description of timelineregionexit event shakaExtern.TimelineregionInfo => shakaExtern.TimelineRegionInfo:

/**
 * @event shaka.Player.TimelineRegionExit
 * @description Fired when the playhead exits a timeline region.
 * @property {string} type
 *   'timelineregionexit'
 * @property {shakaExtern.TimelineregionInfo} detail
 *   An object which contains a description of the region.
 * @exportDoc
 */

@TheModMaker
Copy link
Contributor

Thanks for finding this. Do you want to fix the typo also?

@mrlika
Copy link
Contributor Author

mrlika commented Dec 28, 2017

Yes, I can. Should the typo be fixed in this pull request or in a new one?

@TheModMaker
Copy link
Contributor

You can just update this one.

@shaka-bot
Copy link
Collaborator

All tests passed!

@joeyparrish joeyparrish merged commit 8b66b00 into shaka-project:master Jan 1, 2018
@mrlika mrlika deleted the missing_export_doc branch January 2, 2018 13:53
joeyparrish pushed a commit that referenced this pull request Jan 19, 2018
@mrlika @joeyparrish
Added missing @exportDoc annotations (#1208)
0c47ca8 
* Added missing @exportDoc annotations
* Fixed typo in TimelineRegionExit event description
@joeyparrish
Copy link
Member

Cherry-picked to v2.3.1.

joeyparrish pushed a commit that referenced this pull request Jan 19, 2018
@mrlika @joeyparrish
Added missing @exportDoc annotations (#1208)
5efc7b9 
* Added missing @exportDoc annotations
* Fixed typo in TimelineRegionExit event description
@joeyparrish
Copy link
Member

Cherry-picked for v2.2.10.

@github-actions github-actions bot added the status: archived Archived and locked; will not be updated label Jul 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@joeyparrish joeyparrish joeyparrish approved these changes

Assignees
No one assigned
Labels
status: archived Archived and locked; will not be updated
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@mrlika @TheModMaker @shaka-bot @joeyparrish