github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-03-10 20:20:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Him188 2021-01-05 20:29:24 +08:00
parent 95e6ca4c7a
commit f6faf19ad8
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt
View File

@ -64,6 +64,7 @@ public interface ExternalResource : Closeable {
* png, jpg, gif, tif, bmp, wav, amr, silk
*
* @see net.mamoe.mirai.utils.getFileType
* @see DEFAULT_FORMAT_NAME
*/
public val formatName: String
@ -98,7 +99,7 @@ public interface ExternalResource : Closeable {
*
* 将以只读模式打开这个文件 (因此文件会处于被占用状态), 直到 [ExternalResource.close].
*
* @see ExternalResource.formatName
* @param formatName 查看 [ExternalResource.formatName]
*/
@JvmStatic
@JvmOverloads
@ -112,7 +113,7 @@ public interface ExternalResource : Closeable {
*
* @see closeOriginalFileOnClose 若为 `true`, 在 [ExternalResource.close] 时将会同步关闭 [RandomAccessFile]. 否则不会.
*
* @see ExternalResource.formatName
* @param formatName 查看 [ExternalResource.formatName]
*/
@JvmStatic
@JvmOverloads
@ -126,7 +127,7 @@ public interface ExternalResource : Closeable {
/**
* 创建 [ExternalResource]
*
* @see ExternalResource.formatName
* @param formatName 查看 [ExternalResource.formatName]
*/
@JvmStatic
@JvmOverloads
@ -140,7 +141,7 @@ public interface ExternalResource : Closeable {
*
* **注意**：本函数不会关闭流
*
* @see ExternalResource.formatName
* @param formatName 查看 [ExternalResource.formatName]
*/
@JvmStatic
@JvmOverloads