docs: update docs

Author: engsr6982

docs/tsconfig.json

@@ -4,7 +4,8 @@
     ],
     "exclude": [
         "node_modules/**/*",
-        "../types/api/_/**"
+        "../types/api/_/**",
+        "../types/tsconfig.json"
     ],
     "compilerOptions": {
         "experimentalDecorators": true, // 启用装饰器

docs/typedoc.json

@@ -11,6 +11,7 @@
         "../types/api/_/**",
         "node_modules/**/*",
     ],
+    "name": "API Reference",
     "out": "./reference", // 输出目录
     "readme": "none", // 不生成README.md
     "useCodeBlocks": true, // 使用代码块

types/api/Server.d.ts

@@ -110,7 +110,7 @@ declare class Server {
     /**
      * 根据给定的通用唯一识别码（UUID）获取玩家信息。
      *
-     * @param id 要检索的玩家的通用唯一识别码（UUID）
+     * @param uuid 要检索的玩家的通用唯一识别码（UUID）
      * @return 如果找到，则返回一个玩家对象；否则返回 null
      */
     getPlayer(uuid: UUID): Player;

types/api/actor/Actor.d.ts

@@ -185,7 +185,7 @@ declare class Actor extends CommandSender {
      *
      * @param invisible 是否设置名称标签为不可见。
      */
-    setNameTagAlwaysVisible(visible: string): boolean;
+    setNameTagAlwaysVisible(invisible: string): boolean;
 
     /**
      * 获取角色的当前名称标签。

types/api/command/CommandSender.d.ts

@@ -36,14 +36,14 @@ declare class CommandSender extends Permissible {
      *
      * @param message 要显示的消息
      */
-    sendMessage(...args: any[]): void;
+    sendMessage(...message: any[]): void;
 
     /**
      * @brief 将这个发送者的错误消息发送出去
      *
      * @param message 错误消息要显示
      */
-    sendErrorMessage(...args: any[]): void;
+    sendErrorMessage(...message: any[]): void;
 
     /**
      * @brief 返回运行该命令的服务器实例

types/api/form/Form.d.ts

@@ -27,7 +27,7 @@ declare class Form {
      * @param on_close 回调函数要设置为。
      * @return 当前表单的引用。
      */
-    setOnClose(callback: (player: Player | undefined) => void): this;
+    setOnClose(on_close: (player: Player | undefined) => void): this;
 
     /**
      * @brief 获取表单关闭时的回调函数。

types/api/form/MessageForm.d.ts

@@ -21,7 +21,7 @@ declare class MessageForm extends Form {
      * @param text 要设置为表单内容的文字。
      * @return 当前表单的引用。
      */
-    setContent(msg: Message): this;
+    setContent(text: Message): this;
 
     /**
      * @brief 获取按钮1的文字。
@@ -36,7 +36,7 @@ declare class MessageForm extends Form {
      * @param text 要设置为按钮1文字的文字。
      * @return 当前表单的引用。
      */
-    setButton1(msg: Message): this;
+    setButton1(text: Message): this;
 
     /**
      * @brief 获取按钮2的文字。
@@ -51,15 +51,15 @@ declare class MessageForm extends Form {
      * @param text 要设置为按钮2文字的文字。
      * @return 当前表单的引用。
      */
-    setButton2(msg: Message): this;
+    setButton2(text: Message): this;
 
     /**
      * @brief 设置表单提交时的回调函数。
      *
      * @param on_submit 回调函数要设置为。
      * @return 当前表单的引用。
      */
-    setOnSubmit(fn: (player: Player, index: number) => void): this;
+    setOnSubmit(on_submit: (player: Player, index: number) => void): this;
 
     /**
      * @brief 获取表单提交时的回调函数。

types/api/level/Location.d.ts

@@ -54,5 +54,5 @@ declare class Location extends Position {
      *
      * @param yaw 新旋转的yaw
      */
-    setYaw(): number;
+    setYaw(yaw: number): void;
 }

types/api/level/Position.d.ts

@@ -20,7 +20,7 @@ declare class Position extends Vector {
      *
      * @param dimension 新的维度对象，该位置将位于其中
      */
-    setDimension(dim: Dimension): void;
+    setDimension(dimension: Dimension): void;
 
     /**
      * 获取X组件的下确界值。这表示这个位置所包含的块ID为多少。

types/api/permissions/PermissionAttachment.d.ts

@@ -21,7 +21,7 @@ declare class PermissionAttachment {
     /**
      * 设置一个在附件被移除时要调用的执行器。可以为空。
      *
-     * @param ex 在移除此附件时要调用的执行器
+     * @param callback 在移除此附件时要调用的执行器
      */
     setRemovalCallback(callback: PermissionRemovedExecutor): void;