Skip to content

Commit 18413af

Browse files
authored
Add Settings for Generate Javadoc in Markdown (#4465)
Adds preference "java.codeGeneration.generateCommentsInMarkdown" to generate javadoc in markdown style Server side changes : eclipse-jdtls/eclipse.jdt.ls#3837
1 parent ffbcf2d commit 18413af

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ The following settings are supported:
169169
* `java.codeGeneration.hashCodeEquals.useJava7Objects`: Use Objects.hash and Objects.equals when generating the hashCode and equals methods. This setting only applies to Java 7 and higher. Defaults to `false`.
170170
* `java.codeGeneration.useBlocks`: Use blocks in 'if' statements when generating the methods. Defaults to `false`.
171171
* `java.codeGeneration.generateComments`: Generate method comments when generating the methods. Defaults to `false`.
172+
* `java.codeGeneration.generateCommentsInMarkdown`: Generate Javadoc comments in Markdown style when generating methods, constructors, and types. Requires source compliance >= 23. Defaults to false.
172173
* `java.codeGeneration.toString.template`: The template for generating the toString method. Defaults to `${object.className} [${member.name()}=${member.value}, ${otherMembers}]`.
173174
* `java.codeGeneration.toString.codeStyle`: The code style for generating the toString method. Defaults to `STRING_CONCATENATION`.
174175
* `java.codeGeneration.toString.skipNullValues`: Skip null values when generating the toString method. Defaults to `false`.

package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,6 +1326,11 @@
13261326
"default": false,
13271327
"scope": "window"
13281328
},
1329+
"java.codeGeneration.generateCommentsInMarkdown": {
1330+
"type": "boolean",
1331+
"description": "Generate Javadoc comments in Markdown style (requires source compliance >= 23).",
1332+
"default": false
1333+
},
13291334
"java.codeGeneration.toString.template": {
13301335
"type": "string",
13311336
"description": "The template for generating the toString method.",

0 commit comments

Comments
 (0)