From 8823b268ccea862c3df825bc24a91120e284d211 Mon Sep 17 00:00:00 2001 From: InsanusMokrassar Date: Thu, 15 Aug 2024 02:12:45 +0600 Subject: [PATCH] small fixes in docs --- .../kotlin/dev/inmo/tgbotapi/abstracts/FromUser.kt | 4 ++-- .../kotlin/dev/inmo/tgbotapi/abstracts/WithUser.kt | 6 +++--- .../requests/chat/invite_links/CreateChatInviteLink.kt | 4 +--- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/FromUser.kt b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/FromUser.kt index 6bdb6dcde8..bf5db02eeb 100644 --- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/FromUser.kt +++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/FromUser.kt @@ -3,7 +3,7 @@ package dev.inmo.tgbotapi.abstracts import dev.inmo.tgbotapi.types.chat.User /** - * Inheritors of this interface have some [User] as a source of data. For example, any [dev.inmo.tgbotapi.types.queries.callback.CallbackQuery] + * Inheritors of this interface **may** have some [User] as a source of data. For example, any [dev.inmo.tgbotapi.types.queries.callback.CallbackQuery] * have [User] as the source of that query */ interface OptionallyFromUser : OptionallyWithUser { @@ -15,7 +15,7 @@ interface OptionallyFromUser : OptionallyWithUser { get() = from } /** - * Inheritors of this interface have some [User] as a source of data. For example, any [dev.inmo.tgbotapi.types.queries.callback.CallbackQuery] + * Inheritors of this interface **must** have some [User] as a source of data. For example, any [dev.inmo.tgbotapi.types.queries.callback.CallbackQuery] * have [User] as the source of that query */ interface FromUser : OptionallyFromUser, WithUser { diff --git a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/WithUser.kt b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/WithUser.kt index ab84ded0f1..b629ad4764 100644 --- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/WithUser.kt +++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/abstracts/WithUser.kt @@ -4,16 +4,16 @@ import dev.inmo.tgbotapi.utils.internal.ClassCastsIncluded import dev.inmo.tgbotapi.types.chat.User /** - * All inheritors of this type have [User] in their data as one of the main data + * All inheritors of this type **may** have [User] in their data as one of the main data * - * @see FromUser + * @see OptionallyFromUser */ @ClassCastsIncluded(excludeRegex = ".*Impl") interface OptionallyWithUser { val user: User? } /** - * All inheritors of this type have [User] in their data as one of the main data + * All inheritors of this type **must** have [User] in their data as one of the main data * * @see FromUser */ diff --git a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/chat/invite_links/CreateChatInviteLink.kt b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/chat/invite_links/CreateChatInviteLink.kt index 84619cb79a..d49a98df05 100644 --- a/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/chat/invite_links/CreateChatInviteLink.kt +++ b/tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/chat/invite_links/CreateChatInviteLink.kt @@ -91,9 +91,7 @@ data class CreateChatInviteLinkUnlimited( /** * Represent [request](https://core.telegram.org/bots/api#createchatsubscriptioninvitelink) * - * @see CreateChatInviteLink.unlimited - * @see CreateChatInviteLinkWithLimitedMembers - * @see CreateChatInviteLinkWithJoinRequest + * @see CreateChatInviteLink.subscription */ @Serializable data class CreateChatSubscriptionInviteLink(