Improved docs
This commit is contained in:
parent
020acfed71
commit
8e08a2aac7
2 changed files with 13 additions and 5 deletions
|
@ -12,7 +12,7 @@ import javax.annotation.Nullable;
|
||||||
public interface CommentsInfoItemExtractor extends InfoItemExtractor {
|
public interface CommentsInfoItemExtractor extends InfoItemExtractor {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the like count of the comment, or -1 if it's unavailable<br/>
|
* Return the (approximate) like count of the comment, or -1 if it's unavailable<br/>
|
||||||
* NOTE: Currently only implemented for YT {@link YoutubeCommentsInfoItemExtractor#getLikeCount()}
|
* NOTE: Currently only implemented for YT {@link YoutubeCommentsInfoItemExtractor#getLikeCount()}
|
||||||
* with limitations
|
* with limitations
|
||||||
*
|
*
|
||||||
|
|
|
@ -73,10 +73,18 @@ public class YoutubeCommentsInfoItemExtractor implements CommentsInfoItemExtract
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @implNote The method is parsing internally a localized string.<br/>
|
* @implNote The method is parsing internally a localized string.<br/>
|
||||||
* This will fail for other languages than English.
|
* <ul>
|
||||||
* However as long as the Extractor only uses "en-GB"
|
* <li>
|
||||||
* (as seen in {@link org.schabi.newpipe.extractor.services.youtube.YoutubeService#SUPPORTED_LANGUAGES})
|
* More than >1k likes will result in an inaccurate number
|
||||||
* everything will work fine.<br/>
|
* </li>
|
||||||
|
* <li>
|
||||||
|
* This will fail for other languages than English.
|
||||||
|
* However as long as the Extractor only uses "en-GB"
|
||||||
|
* (as seen in {@link org.schabi.newpipe.extractor.services.youtube.YoutubeService#SUPPORTED_LANGUAGES})
|
||||||
|
* everything will work fine.
|
||||||
|
* </li>
|
||||||
|
* </ul>
|
||||||
|
* <br/>
|
||||||
* Consider using {@link #getTextualVoteCount()}
|
* Consider using {@link #getTextualVoteCount()}
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
|
Loading…
Reference in a new issue