1
0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-09 09:53:47 +00:00

small fixes in docs

This commit is contained in:
InsanusMokrassar 2024-08-15 02:12:45 +06:00
parent 49031bf0e6
commit 8823b268cc
3 changed files with 6 additions and 8 deletions

View File

@ -3,7 +3,7 @@ package dev.inmo.tgbotapi.abstracts
import dev.inmo.tgbotapi.types.chat.User 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 * have [User] as the source of that query
*/ */
interface OptionallyFromUser : OptionallyWithUser { interface OptionallyFromUser : OptionallyWithUser {
@ -15,7 +15,7 @@ interface OptionallyFromUser : OptionallyWithUser {
get() = from 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 * have [User] as the source of that query
*/ */
interface FromUser : OptionallyFromUser, WithUser { interface FromUser : OptionallyFromUser, WithUser {

View File

@ -4,16 +4,16 @@ import dev.inmo.tgbotapi.utils.internal.ClassCastsIncluded
import dev.inmo.tgbotapi.types.chat.User 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") @ClassCastsIncluded(excludeRegex = ".*Impl")
interface OptionallyWithUser { interface OptionallyWithUser {
val user: User? 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 * @see FromUser
*/ */

View File

@ -91,9 +91,7 @@ data class CreateChatInviteLinkUnlimited(
/** /**
* Represent [request](https://core.telegram.org/bots/api#createchatsubscriptioninvitelink) * Represent [request](https://core.telegram.org/bots/api#createchatsubscriptioninvitelink)
* *
* @see CreateChatInviteLink.unlimited * @see CreateChatInviteLink.subscription
* @see CreateChatInviteLinkWithLimitedMembers
* @see CreateChatInviteLinkWithJoinRequest
*/ */
@Serializable @Serializable
data class CreateChatSubscriptionInviteLink( data class CreateChatSubscriptionInviteLink(