Fabio/Auxio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

musikr: reformat

Browse source
This commit is contained in:
Alexander Capehart 2025-03-17 14:02:13 -06:00
parent 6705e869da
commit 7429dd5174
No known key found for this signature in database
GPG key ID: 37DBE3621FE9AD47
4 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
musikr/src/main/java/org/oxycblt/musikr/covers/chained/ChainedCovers.kt
View file

@ -31,8 +31,8 @@ import org.oxycblt.musikr.metadata.Metadata
* This is useful for when you want to try multiple sources for a cover, such as first embedded and * This is useful for when you want to try multiple sources for a cover, such as first embedded and
* then filesystem-based covers. * then filesystem-based covers.
* *
* This implementation will return the first hit from the provided [Covers] instances. * This implementation will return the first hit from the provided [Covers] instances. It's assumed
* It's assumed that there is no ID overlap between [Covers] outputs. * that there is no ID overlap between [Covers] outputs.
* *
* See [MutableChainedCovers] for the mutable variant. * See [MutableChainedCovers] for the mutable variant.
* *
@ -59,8 +59,8 @@ class ChainedCovers<R : Cover, T : R>(vararg many: Covers<out T>) : Covers<R> {
* then filesystem-based covers. * then filesystem-based covers.
* *
* This implementation will use the first hit from the provided [MutableCovers] instances, and * This implementation will use the first hit from the provided [MutableCovers] instances, and
* propagate cleanup across all [MutableCovers] instances. * propagate cleanup across all [MutableCovers] instances. It's assumed that there is no ID overlap
* It's assumed that there is no ID overlap between [MutableCovers] outputs. * between [MutableCovers] outputs.
* *
* See [ChainedCovers] for the immutable variant. * See [ChainedCovers] for the immutable variant.
* *

4
musikr/src/main/java/org/oxycblt/musikr/covers/embedded/EmbeddedCovers.kt
View file

@ -36,8 +36,8 @@ import org.oxycblt.musikr.metadata.Metadata
* - Covers generated by this implementation will take up large amounts of memory, more or less * - Covers generated by this implementation will take up large amounts of memory, more or less
* guaranteeing an OOM error if used with a large library. * guaranteeing an OOM error if used with a large library.
* *
* You are best to compose this with [org.oxycblt.musikr.covers.stored.MutableStoredCovers] to get * You are best to compose this with [org.oxycblt.musikr.covers.stored.MutableStoredCovers] to get a
* a full embedded cover repository. * full embedded cover repository.
* *
* @param coverIdentifier The [CoverIdentifier] to use to create identifiers for the cover data. * @param coverIdentifier The [CoverIdentifier] to use to create identifiers for the cover data.
*/ */

8
musikr/src/main/java/org/oxycblt/musikr/covers/stored/CoverStorage.kt
View file

@ -71,11 +71,11 @@ interface CoverStorage {
companion object { companion object {
/** /**
* Create a [CoverStorage] implementation at some directory. Covers will be written * Create a [CoverStorage] implementation at some directory. Covers will be written in that
* in that location. * location.
* *
* Note that in the context of Android's scoped storage, the given [File] will need to be * Note that in the context of Android's scoped storage, the given [File] will need to be in
* in the app's internal storage * the app's internal storage
* *
* @param dir The directory to store the covers in. * @param dir The directory to store the covers in.
* @return A [CoverStorage] instance. * @return A [CoverStorage] instance.

4
musikr/src/main/java/org/oxycblt/musikr/covers/stored/Transcoding.kt
View file

@ -64,8 +64,8 @@ object NoTranscoding : Transcoding {
* A [Transcoding] implementation that compresses the cover data into a specific format, size, and * A [Transcoding] implementation that compresses the cover data into a specific format, size, and
* quality. * quality.
* *
* This is useful if you want to standardize the covers to a specific format and minimize * This is useful if you want to standardize the covers to a specific format and minimize the size
* the size of the cover data to save space. * of the cover data to save space.
* *
* @param format The [Bitmap.CompressFormat] to use to compress the cover data. * @param format The [Bitmap.CompressFormat] to use to compress the cover data.
* @param resolution The resolution to use for the cover data. * @param resolution The resolution to use for the cover data.