版本 1.0.0

完善文档
去除查询方法中的 retry 参数
去除 USER_LOGGED_OUT 事件
重命名 entities.kt 中部分字段
更新 README

Author: RationalityFrontline

README.md

@@ -1,11 +1,11 @@
 # KTrader-Broker-API 
-[![Apache License 2.0](https://img.shields.io/github/license/rationalityfrontline/ktrader-broker-api)](https://github.com/RationalityFrontline/ktrader-broker-api/blob/master/LICENSE)
+[![Maven Central](https://img.shields.io/maven-central/v/org.rationalityfrontline.ktrader/ktrader-broker-api.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.rationalityfrontline.ktrader%22%20AND%20a:%22ktrader-broker-api%22) [![Apache License 2.0](https://img.shields.io/github/license/ktrader-tech/ktrader-broker-api)](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/LICENSE)
 
-[KTrader](https://github.com/RationalityFrontline/ktrader) 量化交易平台的 broker 统一接口
+[KTrader](https://github.com/ktrader-tech/ktrader) 量化交易平台的 Broker 统一接口
 
 ## License
 
-Ktrader-Broker-API is released under the [Apache 2.0 license](https://github.com/RationalityFrontline/ktrader-broker-api/blob/master/LICENSE).
+Ktrader-Broker-API is released under the [Apache 2.0 license](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/LICENSE).
 
 ```
 Copyright 2021 RationalityFrontline

lib/build.gradle.kts

@@ -3,23 +3,22 @@ plugins {
     `java-library`
     `maven-publish`
     signing
-    id("org.jetbrains.dokka") version "1.4.32"
+    id("org.jetbrains.dokka") version "1.5.0"
     id("org.javamodularity.moduleplugin") version "1.8.7"
 }
 
 group = "org.rationalityfrontline.ktrader"
-version = "0.1.6-SNAPSHOT"
+version = "1.0.0"
 val NAME = "ktrader-broker-api"
 val DESC = "KTrader Broker API"
-val GITHUB_REPO = "RationalityFrontline/ktrader-broker-api"
+val GITHUB_REPO = "ktrader-tech/ktrader-broker-api"
 
 repositories {
-    mavenLocal()
     mavenCentral()
 }
 
 dependencies {
-    compileOnly("org.pf4j:pf4j:3.7.0-SNAPSHOT")
+    compileOnly("org.rationalityfrontline.workaround:pf4j:3.7.0")
     api("org.rationalityfrontline:kevent:2.0.0")
 }
 
@@ -78,8 +77,8 @@ publishing {
                     developer {
                         name.set("RationalityFrontline")
                         email.set("[email protected]")
-                        organization.set("RationalityFrontline")
-                        organizationUrl.set("https://github.com/RationalityFrontline")
+                        organization.set("ktrader-tech")
+                        organizationUrl.set("https://github.com/ktrader-tech")
                     }
                 }
                 scm {

lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/Broker.kt

@@ -3,21 +3,59 @@ package org.rationalityfrontline.ktrader.broker.api
 import org.pf4j.ExtensionPoint
 import org.rationalityfrontline.kevent.KEvent
 
+/**
+ * 交易接口插件类，用于获取相关信息及生成 [BrokerApi] 实例
+ */
 abstract class Broker : ExtensionPoint {
+
+    /**
+     * 交易接口名称。例："CTP"
+     */
     abstract val name: String
+
+    /**
+     * 交易接口版本。
+     */
     abstract val version: String
+
+    /**
+     * 实例化 [BrokerApi] 时所需的参数说明。[Pair.first] 为参数名，[Pair.second] 为参数说明。
+     * 例：Pair("password", "String 投资者资金账号的密码")
+     */
     abstract val configKeys: List<Pair<String, String>>
+
+    /**
+     * [BrokerApi] 成员方法的额外参数（extras: Map<String, Any>?）说明。[Pair.first] 为方法名，[Pair.second] 为额外参数说明。
+     * 例：Pair("insertOrder", "[minVolume: Int]【最小成交量。仅当下单类型为 OrderType.FAK 时生效】")
+     */
     open val methodExtras: List<Pair<String, String>> = listOf()
+
+    /**
+     * 自定义方法的说明（对应 [BrokerApi.customRequest]/[BrokerApi.customSuspendRequest]）。[Pair.first] 为方法名，[Pair.second] 为方法文档（参数说明及返回值说明）。
+     * 例：Pair("suspend fun queryMaxOrderVolume(code: String, direction: Direction, offset: OrderOffset): Int", "[合约代码，买卖方向，开平类型]【查询并返回最大下单量，未查到则返回 0】")
+     */
     open val customMethods: List<Pair<String, String>> = listOf()
+
+    /**
+     * 自定义事件的说明（对应 [CustomEvent]）。[Pair.first] 为事件类型，[Pair.second] 为事件说明。
+     * 例：Pair("TD_MARKET_STATUS_CHANGE", "[data: MarketStatus]【市场交易状态变动】")
+     */
     open val customEvents: List<Pair<String, String>> = listOf()
+
+    /**
+     * 创建 [BrokerApi] 实例
+     * @param config 参见 [configKeys]
+     * @param kEvent 会通过该 [KEvent] 实例推送 [BrokerEvent]，如 [Tick]、成交回报等
+     */
     abstract fun createApi(config: Map<String, Any>, kEvent: KEvent): BrokerApi
-    private fun formatPairList(list: List<Pair<String, String>>): String {
-        return if (list.isEmpty()) "null" else {
-            val indent = "            "
-            list.joinToString(separator = "\n", prefix = "{\n", postfix = "\n$indent}") { "$indent    ${it.first}: ${it.second}" }
-        }
-    }
+
     override fun toString(): String {
+        fun formatPairList(list: List<Pair<String, String>>): String {
+            return if (list.isEmpty()) "null" else {
+                val indent = "            "
+                list.joinToString(separator = "\n", prefix = "{\n", postfix = "\n$indent}") { "$indent    ${it.first}: ${it.second}" }
+            }
+        }
         return """
             Broker@${hashCode()}, name=$name, version=$version
             configKeys: