Skip to content

Commit

Permalink
docs: improve TwitchHelix#getClips javadoc (#731)
Browse files Browse the repository at this point in the history
* Improve javadoc comment from method getClips

* chore: apply suggestions from code review

* chore: add paragraph spacing

---------

Co-authored-by: iProdigy <prodigycreep@gmail.com>
Co-authored-by: iProdigy <gitProdigy@proton.me>
  • Loading branch information
3 people committed Feb 21, 2023
1 parent 5ea5e40 commit a6772f9
Showing 1 changed file with 6 additions and 4 deletions.
Expand Up @@ -1325,11 +1325,13 @@ HystrixCommand<CreateClipList> createClip(

/**
* Gets clip information by clip ID (one or more), broadcaster ID (one only), or game ID (one only).
* Using user-token or app-token to increase rate limits.
* <p>
* For clips returned by game_id or broadcaster_id, the list is in descending order by view count.
* For lists returned by id, the list is in the same order as the input IDs.
*
* @param authToken User or App auth Token, for increased rate-limits
* @param broadcasterId ID of the broadcaster for whom clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
* @param gameId ID of the game for which clips are returned. The number of clips returned is determined by the first query-string parameter (default: 20). Results are ordered by view count.
* @param authToken User or App access token.
* @param broadcasterId ID of the broadcaster for whom clips are returned.
* @param gameId ID of the game for which clips are returned.
* @param id ID of the clip being queried. Limit: 100.
* @param after Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
* @param before Cursor for backward pagination: tells the server where to start fetching the next set of results, in a multi-page response.
Expand Down

0 comments on commit a6772f9

Please sign in to comment.