Skip to content

Commit b112ae4

Browse files
CsCherrYYCsCherrYY
committed
refine descriptions
Signed-off-by: Shi Chen <chenshi@microsoft.com>
1 parent bff3ff6 commit b112ae4

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎package.json‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -684,77 +684,77 @@
684684
"properties": {
685685
"lineSplit": {
686686
"type": "number",
687-
"markdownDescription": "Specify the length of the page. Beyond this length, the formatter will try to split the code, defaults to `120`.",
687+
"markdownDescription": "Specify the length of the page. Beyond this length, the formatter will try to split the code. Defaults to `120`.",
688688
"default": 120
689689
},
690690
"comment.line.length": {
691691
"type": "number",
692-
"markdownDescription": "specify the line length for comments, defaults to `80`.",
692+
"markdownDescription": "Specify the line length for comments. Defaults to `80`.",
693693
"default": 80
694694
},
695695
"join.wrapped.lines": {
696696
"type": "boolean",
697-
"markdownDescription": "Specify whether the formatter can join wrapped lines or not, defaults to `true`.",
697+
"markdownDescription": "Specify whether the formatter can join wrapped lines or not.",
698698
"default": true
699699
},
700700
"use.on.off.tags": {
701701
"type": "boolean",
702-
"markdownDescription": "Use the disabling and enabling tags defined respectively by the `disabling_tag` and the `enabling_tag` options, defaults to `true`.",
702+
"markdownDescription": "Use the disabling and enabling tags defined respectively by the `disabling_tag` and the `enabling_tag` options.",
703703
"default": true
704704
},
705705
"disabling.tag": {
706706
"type": "string",
707-
"markdownDescription": "Define the tag to put in a comment to disable the formatting, defaults to `@formatter:off`.",
707+
"markdownDescription": "Define the tag to put in a comment to disable the formatting. Defaults to `@formatter:off`.",
708708
"default": "@formatter:off"
709709
},
710710
"enabling.tag": {
711711
"type": "string",
712-
"markdownDescription": "Define the tag to put in a comment to enable the formatting, defaults to `@formatter:on`.",
712+
"markdownDescription": "Define the tag to put in a comment to enable the formatting, Defaults to `@formatter:on`.",
713713
"default": "@formatter:on"
714714
},
715715
"indent.parameter.description": {
716716
"type": "boolean",
717-
"markdownDescription": "Control whether description of Javadoc parameters are indented, defaults to `false`.",
717+
"markdownDescription": "Control whether description of Javadoc parameters are indented.",
718718
"default": false
719719
},
720720
"indent.root.tags": {
721721
"type": "boolean",
722-
"markdownDescription": "control whether Javadoc root tags are indented, defaults to `false`.",
722+
"markdownDescription": "Control whether Javadoc root tags are indented.",
723723
"default": false
724724
},
725725
"align.tags.descriptions.grouped": {
726726
"type": "boolean",
727-
"markdownDescription": "Control whether descriptions and names in Javadoc root tags, should be aligned and grouped by tag type., defaults to `true`.",
727+
"markdownDescription": "Control whether descriptions and names in Javadoc root tags, should be aligned and grouped by tag type.",
728728
"default": true
729729
},
730730
"align.tags.names.descriptions": {
731731
"type": "boolean",
732-
"markdownDescription": "control whether names and descriptions in Javadoc root tags should be aligned., defaults to `false`.",
732+
"markdownDescription": "Control whether names and descriptions in Javadoc root tags should be aligned.",
733733
"default": false
734734
},
735735
"clear.blank.lines.in.javadoc.comment": {
736736
"type": "boolean",
737-
"markdownDescription": "Control whether blank lines are cleared inside Javadoc comments, defaults to `false`.",
737+
"markdownDescription": "Control whether blank lines are cleared inside Javadoc comments.",
738738
"default": false
739739
},
740740
"blank.lines.between.import.groups": {
741741
"type": "number",
742-
"markdownDescription": "Add or remove blank lines between import groups, defaults to `1`.",
742+
"markdownDescription": "Control blank lines between import groups.",
743743
"default": 1
744744
},
745745
"format.line.comments": {
746746
"type": "boolean",
747-
"markdownDescription": "Control whether single line comments are formatted, defaults to `true`.",
747+
"markdownDescription": "Control whether single line comments are formatted.",
748748
"default": true
749749
},
750750
"format.block.comments": {
751751
"type": "boolean",
752-
"markdownDescription": "Control whether multiple lines comments are formatted, defaults to `true`.",
752+
"markdownDescription": "Control whether multiple lines comments are formatted.",
753753
"default": true
754754
},
755755
"format.javadoc.comments": {
756756
"type": "boolean",
757-
"markdownDescription": "Control whether Javadoc comments are formatted, defaults to `true`.",
757+
"markdownDescription": "Control whether Javadoc comments are formatted.",
758758
"default": true
759759
},
760760
"parentheses.positions.in.method.invocation": {
@@ -773,7 +773,7 @@
773773
"Set parentheses location on separate lines from their contents, that is put a line break after the opening parenthesis and before the closing parenthesis.",
774774
"Set opening and closing parentheses location to be preserved from the original source."
775775
],
776-
"markdownDescription": "Position parentheses in method invocations, defaults to `commonLines`.",
776+
"markdownDescription": "Position parentheses in method invocations. Defaults to `commonLines`.",
777777
"default": "commonLines"
778778
},
779779
"keep.loop.body.block.on.one.line": {
@@ -792,7 +792,7 @@
792792
"Always keep braced code on one line, as long as it doesn't exceed the line width limit.",
793793
"Keep braced code on one line as long as it doesn't exceed the line width limit and it was already in one line in the original source."
794794
],
795-
"markdownDescription": "Control when a loop body block should be kept on one line, defaults to `never`.",
795+
"markdownDescription": "Control when a loop body block should be kept on one line. Defaults to `never`.",
796796
"default": "never"
797797
},
798798
"keep.anonymous.type.declaration.on.one.line": {
@@ -811,7 +811,7 @@
811811
"Always keep braced code on one line, as long as it doesn't exceed the line width limit.",
812812
"Keep braced code on one line as long as it doesn't exceed the line width limit and it was already in one line in the original source."
813813
],
814-
"markdownDescription": "Control when an anonymous type declaration should be kept on one line, defaults to `never`.",
814+
"markdownDescription": "Control when an anonymous type declaration should be kept on one line. Defaults to `never`.",
815815
"default": "never"
816816
},
817817
"keep.type.declaration.on.one.line": {
@@ -830,7 +830,7 @@
830830
"Always keep braced code on one line, as long as it doesn't exceed the line width limit.",
831831
"Keep braced code on one line as long as it doesn't exceed the line width limit and it was already in one line in the original source."
832832
],
833-
"markdownDescription": "Control when a type declaration should be kept on one line, defaults to `never`.",
833+
"markdownDescription": "Control when a type declaration should be kept on one line. Defaults to `never`.",
834834
"default": "never"
835835
},
836836
"keep.method.body.on.one.line": {
@@ -849,7 +849,7 @@
849849
"Always keep braced code on one line, as long as it doesn't exceed the line width limit.",
850850
"Keep braced code on one line as long as it doesn't exceed the line width limit and it was already in one line in the original source."
851851
],
852-
"markdownDescription": "Control when a method body should be kept on one line, defaults to `never`.",
852+
"markdownDescription": "Control when a method body should be kept on one line. Defaults to `never`.",
853853
"default": "never"
854854
},
855855
"insert.space.after.closing.angle.bracket.in.type.arguments": {
@@ -858,7 +858,7 @@
858858
"insert",
859859
"doNotInsert"
860860
],
861-
"markdownDescription": "Insert a space after the closing angle bracket in explicit type arguments on method/constructor invocations, defaults to `doNotInsert`.",
861+
"markdownDescription": "Insert a space after the closing angle bracket in explicit type arguments on method/constructor invocations.",
862862
"default": "doNotInsert"
863863
},
864864
"insert.space.before.closing.brace.in.array.initializer": {
@@ -867,7 +867,7 @@
867867
"insert",
868868
"doNotInsert"
869869
],
870-
"markdownDescription": "Insert a space before the closing brace in an array initializer, defaults to `insert`.",
870+
"markdownDescription": "Insert a space before the closing brace in an array initializer.",
871871
"default": "insert"
872872
},
873873
"insert.space.after.opening.brace.in.array.initializer": {
@@ -876,7 +876,7 @@
876876
"insert",
877877
"doNotInsert"
878878
],
879-
"markdownDescription": "Insert a space after the opening brace in an array initializer, defaults to `doNotInsert`.",
879+
"markdownDescription": "Insert a space after the opening brace in an array initializer.",
880880
"default": "doNotInsert"
881881
},
882882
"alignment.for.enum.constants": {
@@ -901,7 +901,7 @@
901901
"The wrapping is done by putting each element on its own line except the first element."
902902
],
903903
"default": "compact",
904-
"markdownDescription": "The wrapping style, defaults to `compact`."
904+
"markdownDescription": "The wrapping style. Defaults to `compact`."
905905
},
906906
"force.split": {
907907
"type": "boolean",
@@ -921,7 +921,7 @@
921921
"The wrapping is done by indenting by one compare to the current indentation."
922922
],
923923
"default": "indentDefault",
924-
"markdownDescription": "The indentation style, defaults to `indentDefault`."
924+
"markdownDescription": "The indentation style. Defaults to `indentDefault`."
925925
}
926926
},
927927
"markdownDescription": "Alignment of enum constants.",
@@ -949,7 +949,7 @@
949949
"The wrapping is done by putting each element on its own line except the first element."
950950
],
951951
"default": "compact",
952-
"markdownDescription": "The wrapping style, defaults to `compact`."
952+
"markdownDescription": "The wrapping style. Defaults to `compact`."
953953
},
954954
"force.split": {
955955
"type": "boolean",
@@ -969,7 +969,7 @@
969969
"The wrapping is done by indenting by one compare to the current indentation."
970970
],
971971
"default": "indentDefault",
972-
"markdownDescription": "The indentation style, defaults to `indentDefault`."
972+
"markdownDescription": "The indentation style. Defaults to `indentDefault`."
973973
}
974974
},
975975
"markdownDescription": "alignment of parameters in method declaration.",
@@ -989,7 +989,7 @@
989989
"set a brace location at the start of the next line with an extra indentation.",
990990
"set a brace location at the start of the next line if a wrapping occurred."
991991
],
992-
"markdownDescription": "Position the braces of a block, defaults to `endOfLine`",
992+
"markdownDescription": "Position the braces of a block. Defaults to `endOfLine`",
993993
"default": "endOfLine"
994994
}
995995
},

0 commit comments

Comments
 (0)