Skip to content

Commit 037309a

Browse files
sumnekosumneko
committed
update doc
1 parent cd81adf commit 037309a

File tree

5 files changed

+289
-164
lines changed

5 files changed

+289
-164
lines changed

‎doc/en-us/config.md‎

Lines changed: 67 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ string
2626

2727
## enum
2828

29-
* `"Disable"`: Only shows `function name`.
30-
* `"Both"`: Shows `function name` and `call snippet`.
31-
* `"Replace"`: Only shows `call snippet.`
29+
* ``"Disable"``: Only shows `function name`.
30+
* ``"Both"``: Shows `function name` and `call snippet`.
31+
* ``"Replace"``: Only shows `call snippet.`
32+
3233
## default
3334

3435
```json
@@ -79,9 +80,10 @@ string
7980

8081
## enum
8182

82-
* `"Disable"`: Only shows `keyword`.
83-
* `"Both"`: Shows `keyword` and `syntax snippet`.
84-
* `"Replace"`: Only shows `syntax snippet`.
83+
* ``"Disable"``: Only shows `keyword`.
84+
* ``"Both"``: Shows `keyword` and `syntax snippet`.
85+
* ``"Replace"``: Only shows `syntax snippet`.
86+
8587
## default
8688

8789
```json
@@ -148,9 +150,10 @@ string
148150

149151
## enum
150152

151-
* `"Enable"`: Always show context words in suggestions.
152-
* `"Fallback"`: Contextual words are only displayed when suggestions based on semantics cannot be provided.
153-
* `"Disable"`: Do not display context words.
153+
* ``"Enable"``: Always show context words in suggestions.
154+
* ``"Fallback"``: Contextual words are only displayed when suggestions based on semantics cannot be provided.
155+
* ``"Disable"``: Do not display context words.
156+
154157
## default
155158

156159
```json
@@ -249,9 +252,10 @@ string
249252

250253
## enum
251254

252-
* `"Enable"`: Always diagnose these files.
253-
* `"Opened"`: Only when these files are opened will it be diagnosed.
254-
* `"Disable"`: These files are not diagnosed.
255+
* ``"Enable"``: Always diagnose these files.
256+
* ``"Opened"``: Only when these files are opened will it be diagnosed.
257+
* ``"Disable"``: These files are not diagnosed.
258+
255259
## default
256260

257261
```json
@@ -270,9 +274,10 @@ string
270274

271275
## enum
272276

273-
* `"Enable"`: Always diagnose these files.
274-
* `"Opened"`: Only when these files are opened will it be diagnosed.
275-
* `"Disable"`: These files are not diagnosed.
277+
* ``"Enable"``: Always diagnose these files.
278+
* ``"Opened"``: Only when these files are opened will it be diagnosed.
279+
* ``"Disable"``: These files are not diagnosed.
280+
276281
## default
277282

278283
```json
@@ -294,9 +299,10 @@ object<string, string>
294299

295300
## enum
296301

297-
* `"Any"`
298-
* `"Opened"`
299-
* `"None"`
302+
* ``"Any"``
303+
* ``"Opened"``
304+
* ``"None"``
305+
300306
## default
301307

302308
```json
@@ -360,10 +366,11 @@ object<string, string>
360366

361367
## enum
362368

363-
* `"Error"`
364-
* `"Warning"`
365-
* `"Information"`
366-
* `"Hint"`
369+
* ``"Error"``
370+
* ``"Warning"``
371+
* ``"Information"``
372+
* ``"Hint"``
373+
367374
## default
368375

369376
```json
@@ -491,9 +498,10 @@ string
491498

492499
## enum
493500

494-
* `"Enable"`: Show hints in all tables.
495-
* `"Auto"`: Show hints only when the table is greater than 3 items, or the table is a mixed table.
496-
* `"Disable"`: Disable hints of array index.
501+
* ``"Enable"``: Show hints in all tables.
502+
* ``"Auto"``: Show hints only when the table is greater than 3 items, or the table is a mixed table.
503+
* ``"Disable"``: Disable hints of array index.
504+
497505
## default
498506

499507
```json
@@ -544,9 +552,10 @@ string
544552

545553
## enum
546554

547-
* `"All"`: All types of parameters are shown.
548-
* `"Literal"`: Only literal type parameters are shown.
549-
* `"Disable"`: Disable parameter hints.
555+
* ``"All"``: All types of parameters are shown.
556+
* ``"Literal"``: Only literal type parameters are shown.
557+
* ``"Disable"``: Disable parameter hints.
558+
550559
## default
551560

552561
```json
@@ -730,9 +739,10 @@ object<string, string>
730739

731740
## enum
732741

733-
* `"default"`
734-
* `"enable"`
735-
* `"disable"`
742+
* ``"default"``
743+
* ``"enable"``
744+
* ``"disable"``
745+
736746
## default
737747

738748
```json
@@ -767,10 +777,11 @@ string
767777

768778
## enum
769779

770-
* `"utf8"`
771-
* `"ansi"`
772-
* `"utf16le"`
773-
* `"utf16be"`
780+
* ``"utf8"``
781+
* ``"ansi"``
782+
* ``"utf16le"``
783+
* ``"utf16be"``
784+
774785
## default
775786

776787
```json
@@ -803,6 +814,21 @@ Supports non-standard symbols. Make sure that your runtime environment supports
803814
Array<string>
804815
```
805816

817+
## enum
818+
819+
* ``"//"``
820+
* ``"/**/"``
821+
* ``"`"``
822+
* ``"+="``
823+
* ``"-="``
824+
* ``"*="``
825+
* ``"/="``
826+
* ``"||"``
827+
* ``"&&"``
828+
* ``"!"``
829+
* ``"!="``
830+
* ``"continue"``
831+
806832
## default
807833

808834
```json
@@ -912,11 +938,12 @@ string
912938

913939
## enum
914940

915-
* `"Lua 5.1"`
916-
* `"Lua 5.2"`
917-
* `"Lua 5.3"`
918-
* `"Lua 5.4"`
919-
* `"LuaJIT"`
941+
* ``"Lua 5.1"``
942+
* ``"Lua 5.2"``
943+
* ``"Lua 5.3"``
944+
* ``"Lua 5.4"``
945+
* ``"LuaJIT"``
946+
920947
## default
921948

922949
```json

‎doc/pt-br/config.md‎

Lines changed: 67 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ string
2626

2727
## enum
2828

29-
* `"Disable"`: Only shows `function name`.
30-
* `"Both"`: Shows `function name` and `call snippet`.
31-
* `"Replace"`: Only shows `call snippet.`
29+
* ``"Disable"``: Only shows `function name`.
30+
* ``"Both"``: Shows `function name` and `call snippet`.
31+
* ``"Replace"``: Only shows `call snippet.`
32+
3233
## default
3334

3435
```json
@@ -79,9 +80,10 @@ string
7980

8081
## enum
8182

82-
* `"Disable"`: Only shows `keyword`.
83-
* `"Both"`: Shows `keyword` and `syntax snippet`.
84-
* `"Replace"`: Only shows `syntax snippet`.
83+
* ``"Disable"``: Only shows `keyword`.
84+
* ``"Both"``: Shows `keyword` and `syntax snippet`.
85+
* ``"Replace"``: Only shows `syntax snippet`.
86+
8587
## default
8688

8789
```json
@@ -148,9 +150,10 @@ string
148150

149151
## enum
150152

151-
* `"Enable"`: Always show context words in suggestions.
152-
* `"Fallback"`: Contextual words are only displayed when suggestions based on semantics cannot be provided.
153-
* `"Disable"`: Do not display context words.
153+
* ``"Enable"``: Always show context words in suggestions.
154+
* ``"Fallback"``: Contextual words are only displayed when suggestions based on semantics cannot be provided.
155+
* ``"Disable"``: Do not display context words.
156+
154157
## default
155158

156159
```json
@@ -249,9 +252,10 @@ string
249252

250253
## enum
251254

252-
* `"Enable"`: Always diagnose these files.
253-
* `"Opened"`: Only when these files are opened will it be diagnosed.
254-
* `"Disable"`: These files are not diagnosed.
255+
* ``"Enable"``: Always diagnose these files.
256+
* ``"Opened"``: Only when these files are opened will it be diagnosed.
257+
* ``"Disable"``: These files are not diagnosed.
258+
255259
## default
256260

257261
```json
@@ -270,9 +274,10 @@ string
270274

271275
## enum
272276

273-
* `"Enable"`: Always diagnose these files.
274-
* `"Opened"`: Only when these files are opened will it be diagnosed.
275-
* `"Disable"`: These files are not diagnosed.
277+
* ``"Enable"``: Always diagnose these files.
278+
* ``"Opened"``: Only when these files are opened will it be diagnosed.
279+
* ``"Disable"``: These files are not diagnosed.
280+
276281
## default
277282

278283
```json
@@ -294,9 +299,10 @@ object<string, string>
294299

295300
## enum
296301

297-
* `"Any"`
298-
* `"Opened"`
299-
* `"None"`
302+
* ``"Any"``
303+
* ``"Opened"``
304+
* ``"None"``
305+
300306
## default
301307

302308
```json
@@ -360,10 +366,11 @@ object<string, string>
360366

361367
## enum
362368

363-
* `"Error"`
364-
* `"Warning"`
365-
* `"Information"`
366-
* `"Hint"`
369+
* ``"Error"``
370+
* ``"Warning"``
371+
* ``"Information"``
372+
* ``"Hint"``
373+
367374
## default
368375

369376
```json
@@ -491,9 +498,10 @@ string
491498

492499
## enum
493500

494-
* `"Enable"`: Show hints in all tables.
495-
* `"Auto"`: Show hints only when the table is greater than 3 items, or the table is a mixed table.
496-
* `"Disable"`: Disable hints of array index.
501+
* ``"Enable"``: Show hints in all tables.
502+
* ``"Auto"``: Show hints only when the table is greater than 3 items, or the table is a mixed table.
503+
* ``"Disable"``: Disable hints of array index.
504+
497505
## default
498506

499507
```json
@@ -544,9 +552,10 @@ string
544552

545553
## enum
546554

547-
* `"All"`: All types of parameters are shown.
548-
* `"Literal"`: Only literal type parameters are shown.
549-
* `"Disable"`: Disable parameter hints.
555+
* ``"All"``: All types of parameters are shown.
556+
* ``"Literal"``: Only literal type parameters are shown.
557+
* ``"Disable"``: Disable parameter hints.
558+
550559
## default
551560

552561
```json
@@ -730,9 +739,10 @@ object<string, string>
730739

731740
## enum
732741

733-
* `"default"`
734-
* `"enable"`
735-
* `"disable"`
742+
* ``"default"``
743+
* ``"enable"``
744+
* ``"disable"``
745+
736746
## default
737747

738748
```json
@@ -767,10 +777,11 @@ string
767777

768778
## enum
769779

770-
* `"utf8"`
771-
* `"ansi"`
772-
* `"utf16le"`
773-
* `"utf16be"`
780+
* ``"utf8"``
781+
* ``"ansi"``
782+
* ``"utf16le"``
783+
* ``"utf16be"``
784+
774785
## default
775786

776787
```json
@@ -803,6 +814,21 @@ Supports non-standard symbols. Make sure that your runtime environment supports
803814
Array<string>
804815
```
805816

817+
## enum
818+
819+
* ``"//"``
820+
* ``"/**/"``
821+
* ``"`"``
822+
* ``"+="``
823+
* ``"-="``
824+
* ``"*="``
825+
* ``"/="``
826+
* ``"||"``
827+
* ``"&&"``
828+
* ``"!"``
829+
* ``"!="``
830+
* ``"continue"``
831+
806832
## default
807833

808834
```json
@@ -912,11 +938,12 @@ string
912938

913939
## enum
914940

915-
* `"Lua 5.1"`
916-
* `"Lua 5.2"`
917-
* `"Lua 5.3"`
918-
* `"Lua 5.4"`
919-
* `"LuaJIT"`
941+
* ``"Lua 5.1"``
942+
* ``"Lua 5.2"``
943+
* ``"Lua 5.3"``
944+
* ``"Lua 5.4"``
945+
* ``"LuaJIT"``
946+
920947
## default
921948

922949
```json

0 commit comments

Comments
 (0)