Skip to content

Commit 35e83d2

Browse files
JoshuaKGoldbergJoshuaKGoldberg
committed
chore: ran eslint-plugin-jsdoc/check-tag-names autofixer on fibjs
1 parent 6541af8 commit 35e83d2

51 files changed

Lines changed: 2803 additions & 2812 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎types/fibjs/declare/BufferedStream.d.ts‎

Lines changed: 46 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* *
88
***************************************************************************/
99

10-
/**
10+
/**
1111
* @author Richard <[email protected]>
1212
*
1313
*/
@@ -23,116 +23,115 @@
2323
*/
2424
/// <reference path="Stream.d.ts" />
2525
declare class Class_BufferedStream extends Class_Stream {
26-
26+
2727
/**
28-
* class prop
28+
* class prop
29+
*
2930
*
30-
*
3131
* @brief 查询创建缓存对象时的流对象
32-
*
32+
*
3333
* @readonly
34-
* @type Stream
3534
*/
36-
35+
3736
stream: Class_Stream
38-
37+
3938
/**
40-
* class prop
39+
* class prop
40+
*
4141
*
42-
*
4342
* @brief 查询和设置当前对象处理文本时的字符集，缺省为 utf-8
44-
*
45-
*
46-
* @type String
43+
*
44+
*
45+
*
4746
*/
48-
47+
4948
charset: string
50-
49+
5150
/**
52-
* class prop
51+
* class prop
52+
*
5353
*
54-
*
5554
* @brief 查询和设置行结尾标识，缺省时，posix:\"\\n\"；windows:\"\\r\\n\"
56-
*
57-
*
58-
* @type String
55+
*
56+
*
57+
*
5958
*/
60-
59+
6160
EOL: string
62-
63-
64-
61+
62+
63+
6564
/**
66-
*
65+
*
6766
* @brief BufferedStream 构造函数
6867
* @param stm BufferedStream 的二进制基础流对象
69-
*
70-
*
71-
*
68+
*
69+
*
70+
*
7271
*/
7372
constructor(stm: Class_Stream);
7473

7574
/**
76-
*
75+
*
7776
* @brief 读取指定字符的文本
7877
* @param size 指定读取的文本字符个数，以 utf8 或者指定的编码字节数为准
7978
* @return 返回读取的文本字符串，若无数据可读，或者连接中断，则返回 null
80-
*
81-
*
79+
*
80+
*
8281
* @async
8382
*/
8483
readText(size: number): string;
8584

8685
/**
87-
*
86+
*
8887
* @brief 读取一行文本，行结尾标识基于 EOL 属性的设置，缺省时，posix:\"\\n\"；windows:\"\\r\\n\"
8988
* @param maxlen 指定此次读取的最大字符串，以 utf8 编码字节数为准，缺省不限制字符数
9089
* @return 返回读取的文本字符串，若无数据可读，或者连接中断，则返回 null
91-
*
92-
*
90+
*
91+
*
9392
* @async
9493
*/
9594
readLine(maxlen?: number/** = -1*/): string;
9695

9796
/**
98-
*
97+
*
9998
* @brief 以数组方式读取一组文本行，行结尾标识基于 EOL 属性的设置，缺省时，posix:\"\\n\"；windows:\"\\r\\n\"
10099
* @param maxlines 指定此次读取的最大行数，缺省读取全部文本行
101100
* @return 返回读取的文本行数组，若无数据可读，或者连接中断，空数组
102-
*
103-
*
104-
*
101+
*
102+
*
103+
*
105104
*/
106105
readLines(maxlines?: number/** = -1*/): any[];
107106

108107
/**
109-
*
108+
*
110109
* @brief 读取一个文本字符串，以指定的字节为结尾
111110
* @param mk 指定结尾的字符串
112111
* @param maxlen 指定此次读取的最大字符串，以 utf8 编码字节数为准，缺省不限制字符数
113112
* @return 返回读取的文本字符串，若无数据可读，或者连接中断，则返回 null
114-
*
115-
*
113+
*
114+
*
116115
* @async
117116
*/
118117
readUntil(mk: string, maxlen?: number/** = -1*/): string;
119118

120119
/**
121-
*
120+
*
122121
* @brief 写入一个字符串
123122
* @param txt 指定写入的字符串
124-
*
125-
*
123+
*
124+
*
126125
* @async
127126
*/
128127
writeText(txt: string): void;
129128

130129
/**
131-
*
130+
*
132131
* @brief 写入一个字符串，并写入换行符
133132
* @param txt 指定写入的字符串
134-
*
135-
*
133+
*
134+
*
136135
* @async
137136
*/
138137
writeLine(txt: string): void;

‎types/fibjs/declare/Cipher.d.ts‎

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* *
88
***************************************************************************/
99

10-
/**
10+
/**
1111
* @author Richard <[email protected]>
1212
*
1313
*/
@@ -23,121 +23,121 @@
2323
*/
2424

2525
declare class Class_Cipher extends Class__object {
26-
26+
2727
/**
28-
* class prop
28+
* class prop
29+
*
2930
*
30-
*
3131
* @brief 返回当前算法名称
32-
*
32+
*
3333
* @readonly
34-
* @type String
34+
*
3535
*/
36-
36+
3737
name: string
38-
38+
3939
/**
40-
* class prop
40+
* class prop
41+
*
4142
*
42-
*
4343
* @brief 返回当前算法密码长度，以位为单位
44-
*
44+
*
4545
* @readonly
46-
* @type Integer
46+
* @note Assumed to be an integer.
4747
*/
48-
48+
4949
keySize: number
50-
50+
5151
/**
52-
* class prop
52+
* class prop
53+
*
5354
*
54-
*
5555
* @brief 返回当前算法初始向量长度，以字节为单位
56-
*
56+
*
5757
* @readonly
58-
* @type Integer
58+
* @note Assumed to be an integer.
5959
*/
60-
60+
6161
ivSize: number
62-
62+
6363
/**
64-
* class prop
64+
* class prop
65+
*
6566
*
66-
*
6767
* @brief 返回当前算法数据块长度，以字节为单位
68-
*
68+
*
6969
* @readonly
70-
* @type Integer
70+
* @note Assumed to be an integer.
7171
*/
72-
72+
7373
blockSize: number
74-
75-
76-
74+
75+
76+
7777
/**
78-
*
78+
*
7979
* @brief Cipher 构造函数，仅用于 ARC4 初始化
8080
* @param provider 指定加密算法
8181
* @param key 指定加密解密密码
82-
*
83-
*
84-
*
82+
*
83+
*
84+
*
8585
*/
8686
constructor(provider: number, key: Class_Buffer);
8787

8888
/**
89-
*
89+
*
9090
* @brief Cipher 构造函数
9191
* @param provider 指定加密算法
9292
* @param mode 指定分组密码工作模式
9393
* @param key 指定加密解密密码
94-
*
95-
*
96-
*
94+
*
95+
*
96+
*
9797
*/
9898
constructor(provider: number, mode: number, key: Class_Buffer);
9999

100100
/**
101-
*
101+
*
102102
* @brief Cipher 构造函数
103103
* @param provider 指定加密算法
104104
* @param mode 指定分组密码工作模式
105105
* @param key 指定加密解密密码
106106
* @param iv 指定初始向量
107-
*
108-
*
109-
*
107+
*
108+
*
109+
*
110110
*/
111111
constructor(provider: number, mode: number, key: Class_Buffer, iv: Class_Buffer);
112112

113113
/**
114-
*
114+
*
115115
* @brief 使用填充模式
116116
* @param mode 指定填充模式，缺省为 PADDING_PKCS7
117-
*
118-
*
119-
*
117+
*
118+
*
119+
*
120120
*/
121121
paddingMode(mode: number): void;
122122

123123
/**
124-
*
124+
*
125125
* @brief 使用当前算法密码加密数据
126126
* @param data 指定要加密的数据
127127
* @return 返回加密后的数据
128-
*
129-
*
128+
*
129+
*
130130
* @async
131131
*/
132132
encrypt(data: Class_Buffer): Class_Buffer;
133133

134134
/**
135-
*
135+
*
136136
* @brief 使用当前算法密码解密数据
137137
* @param data 指定要解密的数据
138138
* @return 返回解密后的数据
139-
*
140-
*
139+
*
140+
*
141141
* @async
142142
*/
143143
decrypt(data: Class_Buffer): Class_Buffer;

0 commit comments

Comments
 (0)