Update docs for NetworHandle.close.

This commit is contained in:
Him188 2022-04-24 12:39:50 +01:00
parent a5b52a0b7b
commit 4efdc98cc4

View File

@ -1,10 +1,10 @@
/*
* Copyright 2019-2021 Mamoe Technologies and contributors.
* Copyright 2019-2022 Mamoe Technologies and contributors.
*
* 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
* Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
* 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
* Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
*
* https://github.com/mamoe/mirai/blob/master/LICENSE
* https://github.com/mamoe/mirai/blob/dev/LICENSE
*/
package net.mamoe.mirai.internal.network.handler
@ -145,7 +145,7 @@ internal interface NetworkHandler : CoroutineScope {
suspend fun sendWithoutExpect(packet: OutgoingPacket)
/**
* Closes this handler gracefully (i.e. asynchronously).
* Closes this handler gracefully (i.e. asynchronously). You should provide [cause] as possible as you can to give debugging information.
*
* After invocation of [close], [state] will always be [State.CLOSED].
*/