Mastodon/pachli-android
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: Fix KDoc warnings

Browse Source
This commit is contained in:
Nik Clayton 2023-09-20 12:56:22 +02:00
parent 1aea1cde8b
commit d555e2a69c
6 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/src/main/java/app/pachli/components/notifications/NotificationFetcher.kt
View File

@ -39,7 +39,7 @@ import kotlin.time.Duration.Companion.milliseconds
* *
* Should only be called by a worker thread. * Should only be called by a worker thread.
* *
* @see NotificationWorker * @see app.pachli.worker.NotificationWorker
* @see <a href="https://developer.android.com/guide/background/persistent/threading/worker">Background worker</a> * @see <a href="https://developer.android.com/guide/background/persistent/threading/worker">Background worker</a>
*/ */
@WorkerThread @WorkerThread

2
app/src/main/java/app/pachli/components/timeline/CachedTimelineRepository.kt
View File

@ -99,7 +99,7 @@ class CachedTimelineRepository @Inject constructor(
).flow ).flow
} }
/** Invalidate the active paging source, see [PagingSource.invalidate] */ /** Invalidate the active paging source, see [androidx.paging.PagingSource.invalidate] */
suspend fun invalidate() { suspend fun invalidate() {
// Invalidating when no statuses have been loaded can cause empty timelines because it // Invalidating when no statuses have been loaded can cause empty timelines because it
// cancels the network load. // cancels the network load.

2
app/src/main/java/app/pachli/di/CoroutineScopeModule.kt
View File

@ -30,7 +30,7 @@ import javax.inject.Qualifier
* time, that call should not be cancelled because the user has navigated away from * time, that call should not be cancelled because the user has navigated away from
* the viewmodel that made the call. * the viewmodel that made the call.
* *
* @see https://developer.android.com/topic/architecture/data-layer#make_an_operation_live_longer_than_the_screen * See [make_an_operation_live_longer_than_the_screen](https://developer.android.com/topic/architecture/data-layer#make_an_operation_live_longer_than_the_screen).
*/ */
@Retention(AnnotationRetention.BINARY) @Retention(AnnotationRetention.BINARY)
@Qualifier @Qualifier

2
app/src/main/java/app/pachli/util/CompositeWithOpaqueBackground.kt
View File

@ -49,7 +49,7 @@ import java.security.MessageDigest
* *
* - Creating a mask that matches the partially transparent areas of the image * - Creating a mask that matches the partially transparent areas of the image
* - Creating a new bitmap that, in the areas that match the mask, contains the same background * - Creating a new bitmap that, in the areas that match the mask, contains the same background
* drawable as the [ImageView]. * drawable as the [android.widget.ImageView].
* - Composite the original image over the top * - Composite the original image over the top
* *
* So the partially transparent areas on the original image are composited over the original * So the partially transparent areas on the original image are composited over the original

2
app/src/main/java/app/pachli/util/HttpHeaderLink.kt
View File

@ -23,7 +23,7 @@ import androidx.core.net.toUri
/** /**
* Represents one link and its parameters from the link header of an HTTP message. * Represents one link and its parameters from the link header of an HTTP message.
* *
* @see [RFC5988](https://tools.ietf.org/html/rfc5988) * See [RFC5988](https://tools.ietf.org/html/rfc5988)
*/ */
class HttpHeaderLink class HttpHeaderLink
@VisibleForTesting(otherwise = VisibleForTesting.PRIVATE) @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)

2
app/src/main/java/app/pachli/util/ViewExtensions.kt
View File

@ -72,7 +72,7 @@ fun ViewPager2.reduceSwipeSensitivity() {
* TextViews with an ancestor RecyclerView can forget that they are selectable. Toggling * TextViews with an ancestor RecyclerView can forget that they are selectable. Toggling
* calls to [TextView.setTextIsSelectable] fixes this. * calls to [TextView.setTextIsSelectable] fixes this.
* *
* @see https://issuetracker.google.com/issues/37095917 * See [https://issuetracker.google.com/issues/37095917](https://issuetracker.google.com/issues/37095917)
*/ */
fun TextView.fixTextSelection() { fun TextView.fixTextSelection() {
setTextIsSelectable(false) setTextIsSelectable(false)