Change requirement of image extensions in ImageSuffix class' Javadoc to a possibility
Some services may provide different image formats using the same suffix, without we know what format the service provide. Enforcing an image extension could so lead to provide invalid image URLs, like for SoundCloud PNG images currently. With this documentation change, it is now clear that users of this class decide of whether they want to include image extensions in the suffix. The previous behavior described in the Javadoc was not enforced.
This commit is contained in:
parent
917554acc4
commit
ac00459c1a
|
@ -7,9 +7,9 @@ import java.io.Serializable;
|
||||||
import java.util.Objects;
|
import java.util.Objects;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Serializable class representing a suffix (including its format extension, such as {@code .jpg})
|
* Serializable class representing a suffix (which may include its format extension, such as
|
||||||
* which needs to be added to get an image/thumbnail URL with its corresponding height, width and
|
* {@code .jpg}) which needs to be added to get an image/thumbnail URL with its corresponding
|
||||||
* estimated resolution level.
|
* height, width and estimated resolution level.
|
||||||
*
|
*
|
||||||
* <p>
|
* <p>
|
||||||
* This class is used to construct {@link org.schabi.newpipe.extractor.Image Image}
|
* This class is used to construct {@link org.schabi.newpipe.extractor.Image Image}
|
||||||
|
|
Loading…
Reference in New Issue