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

Update docs

Browse Source
This commit is contained in:
Him188 2020-06-07 18:48:43 +08:00
parent 9fd2468354
commit 4c9532bad6
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt
View File

@ -107,6 +107,8 @@ interface Message { // must be interface. Don't consider any changes.
* println(c) // "Hello world!"
* ```
*
* 在 Java 使用 [plus]
*
* @see plus `+` 操作符重载
*/
@JvmSynthetic // in java they should use `plus` instead
@ -118,11 +120,11 @@ interface Message { // must be interface. Don't consider any changes.
* 在使用消息相关 DSL 和扩展时, 一些内容比较的实现均使用的是 [contentToString] 而不是 [toString]
*
* 各个 [SingleMessage] 的转换示例:
* - [PlainText]: "Hello"
* - [GroupImage]: "[mirai:image:{01E9451B-70ED-EAE3-B37C-101F1EEBF5B5}.mirai]"
* - [FriendImage]: "[mirai:image:/f8f1ab55-bf8e-4236-b55e-955848d7069f]"
* - [PokeMessage]: "[mirai:poke:1,-1]"
* - [MessageChain]: 无间隔地连接所有元素 (`joinToString("")`)
* - [PlainText] : `"Hello"`
* - [GroupImage] : `"[mirai:image:{01E9451B-70ED-EAE3-B37C-101F1EEBF5B5}.mirai]"`
* - [FriendImage] : `"[mirai:image:/f8f1ab55-bf8e-4236-b55e-955848d7069f]"`
* - [PokeMessage] : `"[mirai:poke:1,-1]"`
* - [MessageChain] : 无间隔地连接所有元素 (`joinToString("")`)
* - ...
*
* @see contentToString 转为最接近官方格式的字符串
@ -135,10 +137,10 @@ interface Message { // must be interface. Don't consider any changes.
* 在使用消息相关 DSL 和扩展时, 一些内容比较的实现均使用 [contentToString] 而不是 [toString]
*
* 各个 [SingleMessage] 的转换示例:
* - [PlainText]: "Hello"
* - [Image]: "\[图片\]"
* - [PokeMessage]: "\[戳一戳\]"
* - [MessageChain]: 无间隔地连接所有元素 (`joinToString("", transformer=Message::contentToString)`)
* - [PlainText] : `"Hello"`
* - [Image] : `"[图片]"`
* - [PokeMessage] : `"[戳一戳]"`
* - [MessageChain] : 无间隔地连接所有元素 (`joinToString("", transformer=Message::contentToString)`)
* - ...
*
* @see toString 得到包含 mirai 消息元素代码的, 易读的字符串
@ -152,8 +154,6 @@ interface Message { // must be interface. Don't consider any changes.
* 若本函数返回 `true`, 则表明:
* - `this` 与 [another] 的 [contentToString] 相等
* - `this` 为 [another] 的所有 [MessageContent] 都 [相等][Message.equals] 且有同样的排列顺序.
*
* @sample net.mamoe.mirai.message.data.ContentEqualsTest
*/
/* final */ fun contentEquals(another: Message, ignoreCase: Boolean = false): Boolean =
contentEqualsImpl(another, ignoreCase)
@ -164,8 +164,6 @@ interface Message { // must be interface. Don't consider any changes.
* 若本函数返回 `true`, 则表明:
* - [contentToString] 与 [another] 相等
* - 若 `this` 为 [MessageChain], 则只包含 [MessageMetadata] 和 [PlainText]
*
* @sample net.mamoe.mirai.message.data.ContentEqualsTest
*/
/* final */ fun contentEquals(another: String, ignoreCase: Boolean = false): Boolean {
if (!this.contentToString().equals(another, ignoreCase = ignoreCase)) return false

4
mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/MessageChain.kt
View File

@ -413,8 +413,8 @@ inline fun Array<out SingleMessage>.flatten(): Sequence<SingleMessage> = this.as
* 扁平化 [Message]
*
* 对于不同类型的接收者（receiver）:
* - `CombinedMessage(A, B)` 返回 `A <- B`
* - `MessageChain(E, F, G)` 返回 `E <- F <- G`
* - [CombinedMessage]`(A, B)` 返回 `A <- B`
* - `[MessageChain](E, F, G)` 返回 `E <- F <- G`
* - 其他: 返回 `sequenceOf(this)`
*/
fun Message.flatten(): Sequence<SingleMessage> {