Skip to content

Commit

Permalink
fix javadoc in various java files (#19099)
Browse files Browse the repository at this point in the history
  • Loading branch information
wing328 authored Jul 7, 2024
1 parent 72cdb70 commit b84770a
Show file tree
Hide file tree
Showing 7 changed files with 5 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,8 @@ public class DefaultGenerator implements Generator {
private String contextPath;
private Map<String, String> generatorPropertyDefaults = new HashMap<>();
/**
* -- GETTER --
* Retrieves an instance to the configured template processor, available after user-defined options are
* applied via
* .
*
* @return A configured {@link TemplateProcessor}, or null.
*/
@Getter protected TemplateProcessor templateProcessor = null;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ public interface IJsonSchemaValidationProperties {
* - <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>
* - but that <code>GetAccountVideos_categoryOneOf_parameter</code> class is inside an <code>std::optional</code><br>
* <br>
* 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>
* 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.
* 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>
* 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.
*/
boolean getIsOptional();
void setIsOptional(boolean isOptional);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,7 @@ public class JavaClientCodegen extends AbstractJavaCodegen
@Setter protected String errorObjectType;
protected String authFolder;
/**
* -- GETTER --
* Serialization library.
*
* @return 'gson' or 'jackson'
*/
@Getter protected String serializationLibrary = null;
@Setter protected boolean useOneOfDiscriminatorLookup = false; // use oneOf discriminator's mapping for model lookup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ public void setUseCoroutines(boolean useCoroutines) {
* Sets the serialization engine for Kotlin
*
* @param enumSerializationLibrary The string representation of the serialization library as defined by
* {@link org.openapitools.codegen.languages.AbstractKotlinCodegen.SERIALIZATION_LIBRARY_TYPE}
* {@link org.openapitools.codegen.languages.KotlinClientCodegen.SERIALIZATION_LIBRARY_TYPE}
*/
public void setSerializationLibrary(final String enumSerializationLibrary) {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,8 @@ public class MysqlSchemaCodegen extends DefaultCodegen implements CodegenConfig
));

/**
* -- GETTER --
* Returns default database name for all MySQL queries
* This value must be used with backticks only, eg. `database_name`
*
* @return default database name
* This value must be used with backticks only, e.g. `database_name`
*/
@Getter protected String defaultDatabaseName = "", databaseNamePrefix = "", databaseNameSuffix = "_db";
protected String tableNamePrefix = "tbl_", tableNameSuffix = "";
Expand All @@ -83,10 +80,7 @@ public class MysqlSchemaCodegen extends DefaultCodegen implements CodegenConfig
@Getter @Setter
protected Boolean namedParametersEnabled = false;
/**
* -- GETTER --
* Returns identifier naming convention for table names and column names.
*
* @return identifier naming convention
*/
@Getter protected String identifierNamingConvention = "original";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,7 @@ public class PhpSlim4ServerCodegen extends AbstractPhpCodegen {
protected String appDirName = "App";
protected String appPackage = "";
/**
* -- GETTER --
* Returns PSR-7 implementation package.
*
* @return PSR-7 implementation package
*/
@Getter protected String psr7Implementation = "slim-psr7";
protected String interfacesDirName = "Interfaces";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,16 @@
*/
@Getter public class TemplateManagerOptions {
/**
* -- GETTER --
* Determines whether the template should minimally update a target file.
* A minimal update means the template manager is requested to update a file only if it is newer.
* This option avoids "touching" a file and causing the last modification time (mtime) to change.
*
* @return true to prefer updating only changed files, false to disable that suggestion
*/
private final boolean minimalUpdate;
/**
* -- GETTER --
* Determines whether the template manager should avoid overwriting an existing file.
* This differs from requesting
* which evaluates contents, while this option only
* This differs from requesting which evaluates contents, while this option only
* evaluates whether the file exists.
*
* @return true to avoid overwriting existing files (where supported), false to disable that suggestion.
*/
private final boolean skipOverwrite;

Expand Down

0 comments on commit b84770a

Please sign in to comment.