Skip to content

Commit b84770a

Browse files
authored
fix javadoc in various java files (#19099)
1 parent 72cdb70 commit b84770a

7 files changed

Lines changed: 5 additions & 27 deletions

File tree

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,8 @@ public class DefaultGenerator implements Generator {
9696
private String contextPath;
9797
private Map<String, String> generatorPropertyDefaults = new HashMap<>();
9898
/**
99-
* -- GETTER --
10099
* Retrieves an instance to the configured template processor, available after user-defined options are
101100
* applied via
102-
* .
103-
*
104-
* @return A configured {@link TemplateProcessor}, or null.
105101
*/
106102
@Getter protected TemplateProcessor templateProcessor = null;
107103

modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ public interface IJsonSchemaValidationProperties {
111111
* - <code>categoryOneOf</code> is a parameter of class <code>GetAccountVideos_categoryOneOf_parameter</code>, a model parameter that correctly prefixed by its namespace: <code>org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter</code><br>
112112
* - but that <code>GetAccountVideos_categoryOneOf_parameter</code> class is inside an <code>std::optional</code><br>
113113
* <br>
114-
* Then a correct generation of that parameter can be (for C++) <code>const std::optional<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOf</code><br>
115-
* but using #isModel alone without #isOptional in mustache might produce <code>const org::openapitools::server::model::std::optional<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOf</code> instead, that do not compile.
114+
* Then a correct generation of that parameter can be (for C++) <code>const std::optional&lt;org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter&gt; &amp;categoryOneOf</code><br>
115+
* but using #isModel alone without #isOptional in mustache might produce <code>const org::openapitools::server::model::std::optional&lt;org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter&gt; &amp;categoryOneOf</code> instead, that do not compile.
116116
*/
117117
boolean getIsOptional();
118118
void setIsOptional(boolean isOptional);

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,7 @@ public class JavaClientCodegen extends AbstractJavaCodegen
136136
@Setter protected String errorObjectType;
137137
protected String authFolder;
138138
/**
139-
* -- GETTER --
140139
* Serialization library.
141-
*
142-
* @return 'gson' or 'jackson'
143140
*/
144141
@Getter protected String serializationLibrary = null;
145142
@Setter protected boolean useOneOfDiscriminatorLookup = false; // use oneOf discriminator's mapping for model lookup

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ public void setUseCoroutines(boolean useCoroutines) {
331331
* Sets the serialization engine for Kotlin
332332
*
333333
* @param enumSerializationLibrary The string representation of the serialization library as defined by
334-
* {@link org.openapitools.codegen.languages.AbstractKotlinCodegen.SERIALIZATION_LIBRARY_TYPE}
334+
* {@link org.openapitools.codegen.languages.KotlinClientCodegen.SERIALIZATION_LIBRARY_TYPE}
335335
*/
336336
public void setSerializationLibrary(final String enumSerializationLibrary) {
337337
try {

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/MysqlSchemaCodegen.java

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,8 @@ public class MysqlSchemaCodegen extends DefaultCodegen implements CodegenConfig
6262
));
6363

6464
/**
65-
* -- GETTER --
6665
* Returns default database name for all MySQL queries
67-
* This value must be used with backticks only, eg. `database_name`
68-
*
69-
* @return default database name
66+
* This value must be used with backticks only, e.g. `database_name`
7067
*/
7168
@Getter protected String defaultDatabaseName = "", databaseNamePrefix = "", databaseNameSuffix = "_db";
7269
protected String tableNamePrefix = "tbl_", tableNameSuffix = "";
@@ -83,10 +80,7 @@ public class MysqlSchemaCodegen extends DefaultCodegen implements CodegenConfig
8380
@Getter @Setter
8481
protected Boolean namedParametersEnabled = false;
8582
/**
86-
* -- GETTER --
8783
* Returns identifier naming convention for table names and column names.
88-
*
89-
* @return identifier naming convention
9084
*/
9185
@Getter protected String identifierNamingConvention = "original";
9286

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpSlim4ServerCodegen.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,7 @@ public class PhpSlim4ServerCodegen extends AbstractPhpCodegen {
5454
protected String appDirName = "App";
5555
protected String appPackage = "";
5656
/**
57-
* -- GETTER --
5857
* Returns PSR-7 implementation package.
59-
*
60-
* @return PSR-7 implementation package
6158
*/
6259
@Getter protected String psr7Implementation = "slim-psr7";
6360
protected String interfacesDirName = "Interfaces";

modules/openapi-generator/src/main/java/org/openapitools/codegen/templating/TemplateManagerOptions.java

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,16 @@
77
*/
88
@Getter public class TemplateManagerOptions {
99
/**
10-
* -- GETTER --
1110
* Determines whether the template should minimally update a target file.
1211
* A minimal update means the template manager is requested to update a file only if it is newer.
1312
* This option avoids "touching" a file and causing the last modification time (mtime) to change.
14-
*
15-
* @return true to prefer updating only changed files, false to disable that suggestion
1613
*/
1714
private final boolean minimalUpdate;
1815
/**
1916
* -- GETTER --
2017
* Determines whether the template manager should avoid overwriting an existing file.
21-
* This differs from requesting
22-
* which evaluates contents, while this option only
18+
* This differs from requesting which evaluates contents, while this option only
2319
* evaluates whether the file exists.
24-
*
25-
* @return true to avoid overwriting existing files (where supported), false to disable that suggestion.
2620
*/
2721
private final boolean skipOverwrite;
2822

0 commit comments

Comments
 (0)