docs: missing docs.

fibjs/include/ifs/Buffer.idl

@@ -113,45 +113,48 @@ interface Buffer : object
      */
     Integer write(String str, String codec = "utf8");
 
-    /*! @brief 为Buffer对象填充指定内容数据
-     @param v 需要填充的数据，如果未指定offset和end，将填充满整个buffer
+    /*! @brief 为 Buffer 对象填充指定内容数据
+     @param v 需要填充的数据，如果未指定 offset 和 end，将填充满整个 buffer
      @param offset 填充起始位置
      @param end 填充终止位置
      @return 返回当前 Buffer 对象
      */
     Buffer fill(Integer v, Integer offset = 0, Integer end = -1);
 
-    /*! @brief 为Buffer对象填充指定内容数据
-     @param v 需要填充的数据，如果未指定offset和end，将填充满整个buffer
+    /*! @brief 为 Buffer 对象填充指定内容数据
+     @param v 需要填充的数据，如果未指定 offset 和 end，将填充满整个 buffer
      @param offset 填充起始位置
      @param end 填充终止位置
      @return 返回当前 Buffer 对象
      */
     Buffer fill(Buffer v, Integer offset = 0, Integer end = -1);
 
-    /*! @brief 为Buffer对象填充指定内容数据
-     @param v 需要填充的数据，如果未指定offset和end，将填充满整个buffer
+    /*! @brief 为 Buffer 对象填充指定内容数据
+     @param v 需要填充的数据，如果未指定 offset 和 end，将填充满整个 buffer
      @param offset 填充起始位置
      @param end 填充终止位置
      @return 返回当前 Buffer 对象
      */
     Buffer fill(String v, Integer offset = 0, Integer end = -1);
 
-    /*! @brief 返回某个指定数据在Buffer中首次出现的位置
-     @param v 待查找数据，如果未指定offset，默认从起始位开始
+    /*! @brief 返回某个指定数据在 Buffer 中首次出现的位置
+     @param v 待查找数据，如果未指定 offset，默认从起始位开始
      @param offset 起始查找位置
+     @return 返回查找到的位置，未找到返回 -1
      */
     Integer indexOf(Integer v, Integer offset = 0);
 
-    /*! @brief 返回某个指定数据在Buffer中首次出现的位置
-     @param v 待查找数据，如果未指定offset，默认从起始位开始
+    /*! @brief 返回某个指定数据在 Buffer 中首次出现的位置
+     @param v 待查找数据，如果未指定 offset，默认从起始位开始
      @param offset 起始查找位置
+     @return 返回查找到的位置，未找到返回 -1
      */
     Integer indexOf(Buffer v, Integer offset = 0);
 
-    /*! @brief 返回某个指定数据在Buffer中首次出现的位置
-     @param v 待查找数据，如果未指定offset，默认从起始位开始
+    /*! @brief 返回某个指定数据在 Buffer 中首次出现的位置
+     @param v 待查找数据，如果未指定 offset，默认从起始位开始
      @param offset 起始查找位置
+     @return 返回查找到的位置，未找到返回 -1
      */
     Integer indexOf(String v, Integer offset = 0);
 

fibjs/include/ifs/Event.idl

@@ -10,7 +10,9 @@ interface Event : Lock
      */
     Event(Boolean value = false);
 
-    /*! @brief 判断事件对象是否为true */
+    /*! @brief 判断事件对象是否为真
+     @return 如果事件为真，返回 true
+     */
     Boolean isSet();
 
     /*! @brief 激活事件（将事件状态改为true），并调用pulse() */

fibjs/include/ifs/EventEmitter.idl

@@ -49,8 +49,7 @@ interface EventEmitter : object
     Object prependListener(String ev, Function func);
 
     /*! @brief 绑定一个事件处理函数到对象起始
-    @param ev 指定事件的名称
-    @param func 指定事件处理函数
+    @param map 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数
     @return 返回成功绑定的数量，如果函数已绑定则返回 0
    */
     Object prependListener(Object map);
@@ -76,8 +75,7 @@ interface EventEmitter : object
     Object prependOnceListener(String ev, Function func);
 
     /*! @brief 绑定一个事件处理函数到对象起始
-    @param ev 指定事件的名称
-    @param func 指定事件处理函数
+    @param map 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数
     @return 返回成功绑定的数量，如果函数已绑定则返回 0
    */
     Object prependOnceListener(Object map);
@@ -132,6 +130,7 @@ interface EventEmitter : object
     setMaxListeners(Integer n);
 
     /* 获取监听器的默认限制的数量，仅用于兼容
+    @return 返回默认限制数量
    */
     Integer getMaxListeners();
 

fibjs/include/ifs/HttpCookie.idl

@@ -21,6 +21,7 @@ interface HttpCookie : object
 
     /*! @brief 检测给定的 url 是否匹配当前设置
      @param url 指定测试的 url
+     @return 匹配成功返回 true
     */
     Boolean match(String url);
 

fibjs/include/ifs/LevelDB.idl

@@ -23,6 +23,7 @@ interface LevelDB : object
 
     /*! @brief 查询一组指定键值的值
      @param keys 指定要查询的键值数组
+     @return 返回包含键值得数组
      */
     List mget(Array keys);
 

fibjs/include/ifs/MongoCollection.idl

@@ -65,12 +65,14 @@ interface MongoCollection : object
 
     /*! @brief 执行数据库命令
     @param cmd 给定命令对象
+    @return 返回命令返回结果
    */
     Object runCommand(Object cmd);
 
     /*! @brief 执行数据库命令
     @param cmd 给定命令名称
     @param arg 给定命令参数选项
+    @return 返回命令返回结果
    */
     Object runCommand(String cmd, Object arg = {});
 

fibjs/include/ifs/Redis.idl

@@ -250,6 +250,7 @@ interface Redis : object
     /*! @brief 将信息 message 发送到指定的频道 channel
      @param channel 指定发布的频道
      @param message 指定发布的消息
+     @return 接收此消息的客户端数量
     */
     Integer pub(Buffer channel, Buffer message);
 

fibjs/include/ifs/RedisSet.idl

@@ -35,6 +35,7 @@ interface RedisSet : object
     Integer len();
 
     /*! @brief 判断 member 元素是否集合的成员
+     @param member 指定检查的 member
      @return 如果 member 元素是集合的成员，返回 true */
     Boolean exists(Buffer member);
 

fibjs/include/ifs/Socket.idl

@@ -70,12 +70,21 @@ interface Socket : Stream
      */
     Buffer recv(Integer bytes = -1) async;
 
+    /*! @brief 读取一个 UDP 包
+     @param bytes 指定要读取的数据量，缺省读取任意尺寸的数据
+     @return 返回从连接读取的数据包
+     */
     DatagramPacket recvfrom(Integer bytes = -1) async;
 
     /*! @brief 将给定的数据写入连接，此方法等效于 write 方法
      @param data 给定要写入的数据
      */
     send(Buffer data) async;
 
+    /*! @brief 向给定 ip:port 发送一个 UDP 包
+     @param data 给定要写入的数据
+     @param host 指定目标 ip 或主机名
+     @param port 指定目标端口
+     */
     sendto(Buffer data, String host, Integer port) async;
 };

fibjs/include/ifs/UrlObject.idl

@@ -32,6 +32,7 @@ interface UrlObject : object
 
     /*! @brief 重定位 url 路径，自动识别新路径为相对路径还是绝对路径
      @param url 指定新的路径
+     @return 返回包含重定位数据的对象
      */
     UrlObject resolve(String url);
 

fibjs/include/ifs/Worker.idl

@@ -2,9 +2,17 @@
  */
 interface Worker : EventEmitter
 {
+    /*! @brief Worker 对象构造函数
+     @param path 指定 Worker 入口脚本，只接受绝对路径
+     @param opts 构造选项，暂未支持
+     */
     Worker(String path, Object opts = {});
 
+    /*! @brief 向 Master 或 Worker 发送消息，
+     @param data 指定发送的消息内容
+     */
     postMessage(Value data);
 
+    /*! @brief 查询和绑定接受 postMessage 消息事件，相当于 on("message", func); */
     Function onmessage;
 };

fibjs/include/ifs/XmlCharacterData.idl

@@ -16,6 +16,7 @@ interface XmlCharacterData : XmlNode
     /*! @brief 从节点中提取子串
      @param offset 要返回的第一个字符的位置
      @param count 要返回的子串中的字符数
+     @return 返回提取的字符串
     */
     String substringData(Integer offset, Integer count);
 

fibjs/include/ifs/ZipFile.idl

@@ -1,14 +1,19 @@
 /*! @brief zip 文件访问对象 */
 interface ZipFile : object
 {
-    /*! @brief 获取文件名列表 */
+    /*! @brief 获取文件名列表
+	 @return 返回包含文件名的列表对象
+	 */
     List namelist() async;
 
-    /*! @brief 获取文件信息列表 */
+    /*! @brief 获取文件信息列表 
+	 @return 返回包含文件信息的列表对象
+	 */
     List infolist() async;
 
     /*! @brief 获取文件信息
 	 @param member 指定要获取信息的文件名
+	 @return 返回文件信息对象
 	*/
     ZipInfo getinfo(String member) async;
 

fibjs/include/ifs/crypto.idl

@@ -89,23 +89,27 @@ module crypto
     /*! @brief 加载一个 PEM/DER 格式的密钥文件
      @param filename 密钥文件名
      @param password 解密密码
+     @return 返回包含密钥的对象
     */
     static PKey loadPKey(String filename, String password = "");
 
     /*! @brief 加载一个 CRT/PEM/DER/TXT 格式的证书，可多次调用
 
     loadFile 加载 mozilla 的 certdata,txt， 可于 http://hg.mozilla.org/releases/mozilla-release/raw-file/default/security/nss/lib/ckfw/builtins/certdata.txt 下载使用
      @param filename 证书文件名
+     @return 返回包含证书的对象
     */
     static X509Cert loadCert(String filename);
 
     /*! @brief 加载一个 PEM/DER 格式的撤销证书，可多次调用
      @param filename 撤销证书文件名
+     @return 返回包含撤销证书的对象
     */
     static X509Crl loadCrl(String filename);
 
     /*! @brief 加载一个 PEM/DER 格式的证书请求，可多次调用
      @param filename 证书请求文件名
+     @return 返回包含请求证书的对象
     */
     static X509Req loadReq(String filename);
 

fibjs/include/ifs/fs.idl

@@ -274,6 +274,18 @@ module fs
     static Integer open(String fname, String flags = "r", Integer mode = 0666) async;
 
     /*! @brief fs.open() 的阻塞版本
+
+     参数 flags 支持的方式如下：
+     - 'r' 只读方式，文件不存在则抛出错误。
+     - 'r+' 读写方式，文件不存在则抛出错误。
+     - 'w' 只写方式，文件不存在则自动创建，存在则将被清空。
+     - 'w+' 读写方式，文件不存在则自动创建。
+     - 'a' 只写添加方式，文件不存在则自动创建。
+     - 'a+' 读写添加方式，文件不存在则自动创建。
+     @param fname 指定文件名
+     @param flags 指定文件打开方式，缺省为 "r"，只读方式
+     @param mode 当创建文件的时候，指定文件的模式，默认 0666
+     @return 返回打开的文件描述符
      */
     static Integer openSync(String fname, String flags = "r", Integer mode = 0666);
 
@@ -283,6 +295,7 @@ module fs
     static close(Integer fd) async;
 
     /*! @brief fs.close() 的阻塞版本
+     @param fd 文件描述符
      */
     static closeSync(Integer fd);
 

fibjs/include/ifs/gui.idl

@@ -25,7 +25,9 @@ module gui
     /*! @brief WebView ie 模拟版本，指定 edge */
     const EDGE = 11001;
 
-    /* 设置 WebView 内 ie 模拟版本 */
+    /* 设置 WebView 内 ie 模拟版本 
+     @param ver 指定 ie 模拟版本
+    */
     static setVersion(Integer ver);
 
     /*! @brief 打开一个窗口并访问指定网址

fibjs/include/ifs/os.idl

@@ -11,22 +11,34 @@ module os
     /*! @brief Service 构造函数，参见 Service */
     static Service;
 
-    /*! @brief 查询当前运行环境主机名 */
+    /*! @brief 查询当前运行环境主机名 
+     @return 返回主机名
+    */
     static String hostname();
 
-    /*! @brief the endianness of the CPU for which the fibjs binary was compiled. */
+    /*! @brief 查询当前 CPU 的字节顺序
+     @return 返回字节顺序
+    */
     static String endianness();
 
-    /*! @brief 查询当前运行环境操作系统名称 */
+    /*! @brief 查询当前运行环境操作系统名称 
+     @return 返回系统名称
+    */
     static String type();
 
-    /*! @brief 查询当前运行环境操作系统版本 */
+    /*! @brief 查询当前运行环境操作系统版本
+     @return 返回版本信息
+     */
     static String release();
 
-    /*! @brief 查询当前用户目录 */
+    /*! @brief 查询当前用户目录 
+     @return 返回目录字符串
+    */
     static String homedir();
 
-    /*! @brief 查询当前 cpu 环境，可能的结果为 'amd64', 'arm', 'arm64', 'ia32' */
+    /*! @brief 查询当前 cpu 环境
+     @return 返回 cpu 类型，可能的结果为 'amd64', 'arm', 'arm64', 'ia32' 
+    */
     static String arch();
 
     /*! @brief 查询运行环境当前时区 */
@@ -71,7 +83,8 @@ module os
     static String tmpdir();
 
     /*! @brief 返回当前有效执行用户信息
-      @return 当前有效执行用户信息
+     @param options 用于解释结果字符串的字符编码
+     @return 当前有效执行用户信息
     */
     static Object userInfo(Object options = {});
 
@@ -91,7 +104,9 @@ module os
     */
     static BufferedStream openPrinter(String name) async;
 
-    /*! @brief 查询当前平台名称，可能的结果为 'darwin', 'freebsd', 'linux', 或 'win32' */
+    /*! @brief 查询当前平台名称
+     @return 返回平台名称，可能的结果为 'darwin', 'freebsd', 'linux', 或 'win32' 
+     */
     static String platform();
 
     /*! @brief 解析时间字符串或查询运行环境当前时间

fibjs/include/ifs/querystring.idl

@@ -8,13 +8,13 @@
 module querystring
 {
     /*! @brief url 部件字符串安全编码
-     @param url 要编码的 url
+     @param str 要编码的 url
      @return 返回编码的字符串
      */
     static String escape(String str);
 
     /*! @brief url 安全字符串解码
-     @param url 要解码的 url
+     @param str 要解码的 url
      @return 返回解码的字符串
      */
     static String unescape(String str);
@@ -23,6 +23,7 @@ module querystring
      @param str 要解析的字符串
      @param sep 解析时使用的分割字符串，缺省为 &
      @param eq 解析时使用的赋值字符串，缺省为 =
+     @param opt 解析参数，暂未支持
      @return 返回解码的对象
      */
     static HttpCollection parse(String str, String sep = "&", String eq = "=", Object opt = {});
@@ -31,6 +32,7 @@ module querystring
      @param obj 要序列化的对象
      @param sep 序列化时使用的分割字符串，缺省为 &
      @param eq 序列化时使用的赋值字符串，缺省为 =
+     @param opt 解析参数，暂未支持
      @return 返回序列化后的字符串
      */
     static String stringify(Object obj, String sep = "&", String eq = "=", Object opt = {});

fibjs/include/ifs/url.idl

@@ -3,12 +3,14 @@ module url
 {
     /*! @brief 参数构造 UrlObject 对象
      @param args 指定构造参数的字典对象，支持的字段有：protocol, slashes, username, password, hostname, port, pathname, query, hash
+     @return 返回构造成功的字符串
      */
     static String format(Object args);
 
     /*! @brief 解析一个 url 字符串
      @param url 指定需要解析的 url 字符串
      @param parseQueryString 指定是否解析 query
+     @return 返回包含解析数据的对象
      */
     static UrlObject parse(String url, Boolean parseQueryString = false);
 };