Skip to content

Commit 3cfb110

Browse files
committed
fix javadoc erorr in CI
1 parent 7fb4104 commit 3cfb110

File tree

6 files changed

+24
-5
lines changed

6 files changed

+24
-5
lines changed

modules/swagger-codegen/src/main/java/io/swagger/codegen/AbstractGenerator.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ public Reader getTemplateReader(String name) {
6666
/**
6767
* Get the template file path with template dir prepended, and use the
6868
* library template if exists.
69+
*
70+
* @param config Codegen config
71+
* @param templateFile Template file
6972
*/
7073
public String getFullTemplateFile(CodegenConfig config, String templateFile) {
7174
String library = config.getLibrary();

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConfig.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ public interface CodegenConfig {
147147

148148
/**
149149
* Library template (sub-template).
150+
*
151+
* @return libray template
150152
*/
151153
String getLibrary();
152154
}

modules/swagger-codegen/src/main/java/io/swagger/codegen/DefaultCodegen.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2193,6 +2193,8 @@ public void setLibrary(String library) {
21932193

21942194
/**
21952195
* Library template (sub-template).
2196+
*
2197+
* @return Library template
21962198
*/
21972199
public String getLibrary() {
21982200
return library;
@@ -2257,10 +2259,10 @@ public String sanitizeName(String name) {
22572259
}
22582260

22592261
/**
2260-
* only write if the file doesn't exist
2262+
* Only write if the file doesn't exist
22612263
*
2262-
* @param outputFolder
2263-
* @param supportingFile
2264+
* @param outputFolder Output folder
2265+
* @param supportingFile Supporting file
22642266
*/
22652267
public void writeOptional(String outputFolder, SupportingFile supportingFile) {
22662268
String folder = "";
@@ -2283,8 +2285,8 @@ public void writeOptional(String outputFolder, SupportingFile supportingFile) {
22832285
/**
22842286
* Set CodegenParameter boolean flag using CodegenProperty.
22852287
*
2286-
* @param p Codegen Parameter
2287-
* @param cp Codegen property
2288+
* @param parameter Codegen Parameter
2289+
* @param property Codegen property
22882290
*/
22892291
public void setParameterBooleanFlagWithCodegenProperty(CodegenParameter parameter, CodegenProperty property) {
22902292
if (parameter == null) {

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,9 @@ public String toDefaultValueWithParam(String name, Property p) {
385385

386386
/**
387387
* Normalize type by wrapping primitive types with single quotes.
388+
*
389+
* @param type Primitive type
390+
* @return Normalized type
388391
*/
389392
public String normalizeType(String type) {
390393
return type.replaceAll("\\b(Boolean|Integer|Number|String|Date)\\b", "'$1'");

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PythonClientCodegen.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,9 @@ public void setPackageVersion(String packageVersion) {
293293
*
294294
* (PEP 0008) Python packages should also have short, all-lowercase names,
295295
* although the use of underscores is discouraged.
296+
*
297+
* @param packageName Package name
298+
* @return Python package name that conforms to PEP 0008
296299
*/
297300
@SuppressWarnings("static-method")
298301
public String generatePackageName(String packageName) {

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/RubyClientCodegen.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,9 @@ public String getHelp() {
211211

212212
/**
213213
* Generate Ruby module name from the gem name, e.g. use "SwaggerClient" for "swagger_client".
214+
*
215+
* @param gemName Ruby gem name
216+
* @return Ruby module naame
214217
*/
215218
@SuppressWarnings("static-method")
216219
public String generateModuleName(String gemName) {
@@ -219,6 +222,9 @@ public String generateModuleName(String gemName) {
219222

220223
/**
221224
* Generate Ruby gem name from the module name, e.g. use "swagger_client" for "SwaggerClient".
225+
*
226+
* @param moduleName Ruby module naame
227+
* @return Ruby gem name
222228
*/
223229
@SuppressWarnings("static-method")
224230
public String generateGemName(String moduleName) {

0 commit comments

Comments
 (0)