fix javadoc in various java files (#19099)

This commit is contained in:
William Cheng 2024-07-07 18:27:23 +08:00 committed by GitHub
parent 72cdb7020e
commit b84770af16
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 5 additions and 27 deletions

View File

@ -96,12 +96,8 @@ public class DefaultGenerator implements Generator {
private String contextPath; private String contextPath;
private Map<String, String> generatorPropertyDefaults = new HashMap<>(); private Map<String, String> generatorPropertyDefaults = new HashMap<>();
/** /**
* -- GETTER --
* Retrieves an instance to the configured template processor, available after user-defined options are * Retrieves an instance to the configured template processor, available after user-defined options are
* applied via * applied via
* .
*
* @return A configured {@link TemplateProcessor}, or null.
*/ */
@Getter protected TemplateProcessor templateProcessor = null; @Getter protected TemplateProcessor templateProcessor = null;

View File

@ -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> * - <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> * - but that <code>GetAccountVideos_categoryOneOf_parameter</code> class is inside an <code>std::optional</code><br>
* <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> * 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<org::openapitools::server::model::GetAccountVideos_categoryOneOf_parameter> &categoryOneOf</code> instead, that do not compile. * 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(); boolean getIsOptional();
void setIsOptional(boolean isOptional); void setIsOptional(boolean isOptional);

View File

@ -136,10 +136,7 @@ public class JavaClientCodegen extends AbstractJavaCodegen
@Setter protected String errorObjectType; @Setter protected String errorObjectType;
protected String authFolder; protected String authFolder;
/** /**
* -- GETTER --
* Serialization library. * Serialization library.
*
* @return 'gson' or 'jackson'
*/ */
@Getter protected String serializationLibrary = null; @Getter protected String serializationLibrary = null;
@Setter protected boolean useOneOfDiscriminatorLookup = false; // use oneOf discriminator's mapping for model lookup @Setter protected boolean useOneOfDiscriminatorLookup = false; // use oneOf discriminator's mapping for model lookup

View File

@ -331,7 +331,7 @@ public class KotlinClientCodegen extends AbstractKotlinCodegen {
* Sets the serialization engine for Kotlin * Sets the serialization engine for Kotlin
* *
* @param enumSerializationLibrary The string representation of the serialization library as defined by * @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) { public void setSerializationLibrary(final String enumSerializationLibrary) {
try { try {

View File

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

View File

@ -54,10 +54,7 @@ public class PhpSlim4ServerCodegen extends AbstractPhpCodegen {
protected String appDirName = "App"; protected String appDirName = "App";
protected String appPackage = ""; protected String appPackage = "";
/** /**
* -- GETTER --
* Returns PSR-7 implementation package. * Returns PSR-7 implementation package.
*
* @return PSR-7 implementation package
*/ */
@Getter protected String psr7Implementation = "slim-psr7"; @Getter protected String psr7Implementation = "slim-psr7";
protected String interfacesDirName = "Interfaces"; protected String interfacesDirName = "Interfaces";

View File

@ -7,22 +7,16 @@ import lombok.Getter;
*/ */
@Getter public class TemplateManagerOptions { @Getter public class TemplateManagerOptions {
/** /**
* -- GETTER --
* Determines whether the template should minimally update a target file. * 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. * 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. * 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; private final boolean minimalUpdate;
/** /**
* -- GETTER -- * -- GETTER --
* Determines whether the template manager should avoid overwriting an existing file. * Determines whether the template manager should avoid overwriting an existing file.
* This differs from requesting * This differs from requesting which evaluates contents, while this option only
* which evaluates contents, while this option only
* evaluates whether the file exists. * evaluates whether the file exists.
*
* @return true to avoid overwriting existing files (where supported), false to disable that suggestion.
*/ */
private final boolean skipOverwrite; private final boolean skipOverwrite;