Skip to content

Commit 04f26a9

Browse files
bnasslahsenbnasslahsen
committed
javadoc update
1 parent b664aa0 commit 04f26a9

File tree

62 files changed

+771
-648
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+771
-648
lines changed

‎springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestService.java

+36-36
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,10 @@ public abstract class AbstractRequestService {
158158
/**
159159
* Instantiates a new Abstract request builder.
160160
*
161-
* @param parameterBuilder the parameter builder
162-
* @param requestBodyService the request body builder
163-
* @param operationService the operation builder
164-
* @param parameterCustomizers the parameter customizers
161+
* @param parameterBuilder the parameter builder
162+
* @param requestBodyService the request body builder
163+
* @param operationService the operation builder
164+
* @param parameterCustomizers the parameter customizers
165165
* @param localSpringDocParameterNameDiscoverer the local spring doc parameter name discoverer
166166
*/
167167
protected AbstractRequestService(GenericParameterService parameterBuilder, RequestBodyService requestBodyService,
@@ -200,7 +200,7 @@ public static void removeRequestWrapperToIgnore(Class<?>... classes) {
200200
/**
201201
* Is request type to ignore boolean.
202202
*
203-
* @param rawClass the raw class
203+
* @param rawClass the raw class
204204
* @return the boolean
205205
*/
206206
public static boolean isRequestTypeToIgnore(Class<?> rawClass) {
@@ -210,11 +210,11 @@ public static boolean isRequestTypeToIgnore(Class<?> rawClass) {
210210
/**
211211
* Build operation.
212212
*
213-
* @param handlerMethod the handler method
214-
* @param requestMethod the request method
215-
* @param operation the operation
216-
* @param methodAttributes the method attributes
217-
* @param openAPI the open api
213+
* @param handlerMethod the handler method
214+
* @param requestMethod the request method
215+
* @param operation the operation
216+
* @param methodAttributes the method attributes
217+
* @param openAPI the open api
218218
* @return the operation
219219
*/
220220
public Operation build(HandlerMethod handlerMethod, RequestMethod requestMethod,
@@ -281,10 +281,10 @@ else if (!RequestMethod.GET.equals(requestMethod)) {
281281
/**
282282
* Gets parameter linked hash map.
283283
*
284-
* @param components the components
285-
* @param methodAttributes the method attributes
286-
* @param operationParameters the operation parameters
287-
* @param parametersDocMap the parameters doc map
284+
* @param components the components
285+
* @param methodAttributes the method attributes
286+
* @param operationParameters the operation parameters
287+
* @param parametersDocMap the parameters doc map
288288
* @return the parameter linked hash map
289289
*/
290290
private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components components, MethodAttributes methodAttributes, List<Parameter> operationParameters, Map<String, io.swagger.v3.oas.annotations.Parameter> parametersDocMap) {
@@ -314,8 +314,8 @@ private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components co
314314
/**
315315
* Gets headers.
316316
*
317-
* @param methodAttributes the method attributes
318-
* @param map the map
317+
* @param methodAttributes the method attributes
318+
* @param map the map
319319
* @return the headers
320320
*/
321321
@SuppressWarnings("unchecked")
@@ -336,8 +336,8 @@ public static Collection<Parameter> getHeaders(MethodAttributes methodAttributes
336336
/**
337337
* Customise parameter parameter.
338338
*
339-
* @param parameter the parameter
340-
* @param parameterInfo the parameter info
339+
* @param parameter the parameter
340+
* @param parameterInfo the parameter info
341341
* @return the parameter
342342
*/
343343
protected Parameter customiseParameter(Parameter parameter, ParameterInfo parameterInfo) {
@@ -348,7 +348,7 @@ protected Parameter customiseParameter(Parameter parameter, ParameterInfo parame
348348
/**
349349
* Is param to ignore boolean.
350350
*
351-
* @param parameter the parameter
351+
* @param parameter the parameter
352352
* @return the boolean
353353
*/
354354
public boolean isParamToIgnore(MethodParameter parameter) {
@@ -362,7 +362,7 @@ public boolean isParamToIgnore(MethodParameter parameter) {
362362
/**
363363
* Is required annotation boolean.
364364
*
365-
* @param parameter the parameter
365+
* @param parameter the parameter
366366
* @return the boolean
367367
*/
368368
private boolean isRequiredAnnotation(MethodParameter parameter) {
@@ -377,8 +377,8 @@ private boolean isRequiredAnnotation(MethodParameter parameter) {
377377
/**
378378
* Sets params.
379379
*
380-
* @param operation the operation
381-
* @param operationParameters the operation parameters
380+
* @param operation the operation
381+
* @param operationParameters the operation parameters
382382
* @param requestBodyInfo the request body info
383383
*/
384384
private void setParams(Operation operation, List<Parameter> operationParameters, RequestBodyInfo requestBodyInfo) {
@@ -391,7 +391,7 @@ private void setParams(Operation operation, List<Parameter> operationParameters,
391391
/**
392392
* Is valid parameter boolean.
393393
*
394-
* @param parameter the parameter
394+
* @param parameter the parameter
395395
* @return the boolean
396396
*/
397397
public boolean isValidParameter(Parameter parameter) {
@@ -401,10 +401,10 @@ public boolean isValidParameter(Parameter parameter) {
401401
/**
402402
* Build params parameter.
403403
*
404-
* @param parameterInfo the parameter info
405-
* @param components the components
406-
* @param requestMethod the request method
407-
* @param jsonView the json view
404+
* @param parameterInfo the parameter info
405+
* @param components the components
406+
* @param requestMethod the request method
407+
* @param jsonView the json view
408408
* @return the parameter
409409
*/
410410
public Parameter buildParams(ParameterInfo parameterInfo, Components components,
@@ -433,9 +433,9 @@ public Parameter buildParams(ParameterInfo parameterInfo, Components components,
433433
/**
434434
* Build param parameter.
435435
*
436-
* @param parameterInfo the parameter info
437-
* @param components the components
438-
* @param jsonView the json view
436+
* @param parameterInfo the parameter info
437+
* @param components the components
438+
* @param jsonView the json view
439439
* @return the parameter
440440
*/
441441
private Parameter buildParam(ParameterInfo parameterInfo, Components components, JsonView jsonView) {
@@ -472,7 +472,7 @@ private Parameter buildParam(ParameterInfo parameterInfo, Components components,
472472
/**
473473
* Apply bean validator annotations.
474474
*
475-
* @param parameter the parameter
475+
* @param parameter the parameter
476476
* @param annotations the annotations
477477
*/
478478
public void applyBeanValidatorAnnotations(final Parameter parameter, final List<Annotation> annotations) {
@@ -489,8 +489,8 @@ public void applyBeanValidatorAnnotations(final Parameter parameter, final List<
489489
/**
490490
* Apply bean validator annotations.
491491
*
492-
* @param requestBody the request body
493-
* @param annotations the annotations
492+
* @param requestBody the request body
493+
* @param annotations the annotations
494494
* @param isOptional the is optional
495495
*/
496496
public void applyBeanValidatorAnnotations(final RequestBody requestBody, final List<Annotation> annotations, boolean isOptional) {
@@ -516,7 +516,7 @@ public void applyBeanValidatorAnnotations(final RequestBody requestBody, final L
516516
/**
517517
* Calculate size.
518518
*
519-
* @param annos the annos
519+
* @param annos the annos
520520
* @param schema the schema
521521
*/
522522
private void calculateSize(Map<String, Annotation> annos, Schema<?> schema) {
@@ -545,7 +545,7 @@ public RequestBodyService getRequestBodyBuilder() {
545545
/**
546546
* Gets api parameters.
547547
*
548-
* @param method the method
548+
* @param method the method
549549
* @return the api parameters
550550
*/
551551
private Map<String, io.swagger.v3.oas.annotations.Parameter> getApiParameters(Method method) {
@@ -584,7 +584,7 @@ private Map<String, io.swagger.v3.oas.annotations.Parameter> getApiParameters(Me
584584
/**
585585
* Apply validations to schema.
586586
*
587-
* @param annos the annos
587+
* @param annos the annos
588588
* @param schema the schema
589589
*/
590590
private void applyValidationsToSchema(Map<String, Annotation> annos, Schema<?> schema) {

‎springdoc-openapi-common/src/main/java/org/springdoc/core/ActuatorProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ default Tag getTag() {
6262
/**
6363
* Is rest controller boolean.
6464
*
65-
* @param operationPath the operation path
66-
* @param controllerClass the controller class
65+
* @param operationPath the operation path
66+
* @param controllerClass the controller class
6767
* @return the boolean
6868
*/
6969
default boolean isRestController(String operationPath, Class<?> controllerClass) {

‎springdoc-openapi-common/src/main/java/org/springdoc/core/DelegatingMethodParameter.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ public class DelegatingMethodParameter extends MethodParameter {
7171
/**
7272
* Instantiates a new Delegating method parameter.
7373
*
74-
* @param delegate the delegate
75-
* @param parameterName the parameter name
76-
* @param additionalParameterAnnotations the additional parameter annotations
74+
* @param delegate the delegate
75+
* @param parameterName the parameter name
76+
* @param additionalParameterAnnotations the additional parameter annotations
7777
* @param isParameterObject the is parameter object
7878
*/
7979
DelegatingMethodParameter(MethodParameter delegate, String parameterName, Annotation[] additionalParameterAnnotations, boolean isParameterObject) {
@@ -87,9 +87,9 @@ public class DelegatingMethodParameter extends MethodParameter {
8787
/**
8888
* Customize method parameter [ ].
8989
*
90-
* @param pNames the p names
91-
* @param parameters the parameters
92-
* @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
90+
* @param pNames the p names
91+
* @param parameters the parameters
92+
* @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
9393
* @return the method parameter [ ]
9494
*/
9595
public static MethodParameter[] customize(String[] pNames, MethodParameter[] parameters, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {

‎springdoc-openapi-common/src/main/java/org/springdoc/core/GenericParameterService.java

+27-27
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public class GenericParameterService {
8989
/**
9090
* Instantiates a new Generic parameter builder.
9191
*
92-
* @param propertyResolverUtils the property resolver utils
92+
* @param propertyResolverUtils the property resolver utils
9393
* @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
9494
*/
9595
public GenericParameterService(PropertyResolverUtils propertyResolverUtils, Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer) {
@@ -109,7 +109,7 @@ public static void addFileType(Class<?>... classes) {
109109
/**
110110
* Is file boolean.
111111
*
112-
* @param type the type
112+
* @param type the type
113113
* @return the boolean
114114
*/
115115
public static boolean isFile(Class type) {
@@ -119,8 +119,8 @@ public static boolean isFile(Class type) {
119119
/**
120120
* Merge parameter parameter.
121121
*
122-
* @param existingParamDoc the existing param doc
123-
* @param paramCalcul the param calcul
122+
* @param existingParamDoc the existing param doc
123+
* @param paramCalcul the param calcul
124124
* @return the parameter
125125
*/
126126
public static Parameter mergeParameter(List<Parameter> existingParamDoc, Parameter paramCalcul) {
@@ -141,7 +141,7 @@ public static Parameter mergeParameter(List<Parameter> existingParamDoc, Paramet
141141
/**
142142
* Merge parameter.
143143
*
144-
* @param paramCalcul the param calcul
144+
* @param paramCalcul the param calcul
145145
* @param paramDoc the param doc
146146
*/
147147
private static void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {
@@ -188,9 +188,9 @@ private static void mergeParameter(Parameter paramCalcul, Parameter paramDoc) {
188188
/**
189189
* Build parameter from doc parameter.
190190
*
191-
* @param parameterDoc the parameter doc
192-
* @param components the components
193-
* @param jsonView the json view
191+
* @param parameterDoc the parameter doc
192+
* @param components the components
193+
* @param jsonView the json view
194194
* @return the parameter
195195
*/
196196
public Parameter buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter parameterDoc,
@@ -237,9 +237,9 @@ public Parameter buildParameterFromDoc(io.swagger.v3.oas.annotations.Parameter p
237237
/**
238238
* Sets schema.
239239
*
240-
* @param parameterDoc the parameter doc
241-
* @param components the components
242-
* @param jsonView the json view
240+
* @param parameterDoc the parameter doc
241+
* @param components the components
242+
* @param jsonView the json view
243243
* @param parameter the parameter
244244
*/
245245
private void setSchema(io.swagger.v3.oas.annotations.Parameter parameterDoc, Components components, JsonView jsonView, Parameter parameter) {
@@ -263,10 +263,10 @@ private void setSchema(io.swagger.v3.oas.annotations.Parameter parameterDoc, Com
263263
/**
264264
* Calculate schema schema.
265265
*
266-
* @param components the components
267-
* @param parameterInfo the parameter info
268-
* @param requestBodyInfo the request body info
269-
* @param jsonView the json view
266+
* @param components the components
267+
* @param parameterInfo the parameter info
268+
* @param requestBodyInfo the request body info
269+
* @param jsonView the json view
270270
* @return the schema
271271
*/
272272
Schema calculateSchema(Components components, ParameterInfo parameterInfo, RequestBodyInfo requestBodyInfo, JsonView jsonView) {
@@ -291,11 +291,11 @@ Schema calculateSchema(Components components, ParameterInfo parameterInfo, Reque
291291
/**
292292
* Calculate request body schema schema.
293293
*
294-
* @param components the components
295-
* @param parameterInfo the parameter info
296-
* @param requestBodyInfo the request body info
297-
* @param schemaN the schema n
298-
* @param paramName the param name
294+
* @param components the components
295+
* @param parameterInfo the parameter info
296+
* @param requestBodyInfo the request body info
297+
* @param schemaN the schema n
298+
* @param paramName the param name
299299
* @return the schema
300300
*/
301301
private Schema calculateRequestBodySchema(Components components, ParameterInfo parameterInfo, RequestBodyInfo requestBodyInfo, Schema schemaN, String paramName) {
@@ -327,7 +327,7 @@ else if (schemaN instanceof FileSchema || schemaN instanceof ArraySchema && ((Ar
327327
/**
328328
* Sets examples.
329329
*
330-
* @param parameterDoc the parameter doc
330+
* @param parameterDoc the parameter doc
331331
* @param parameter the parameter
332332
*/
333333
private void setExamples(io.swagger.v3.oas.annotations.Parameter parameterDoc, Parameter parameter) {
@@ -350,7 +350,7 @@ private void setExamples(io.swagger.v3.oas.annotations.Parameter parameterDoc, P
350350
/**
351351
* Sets extensions.
352352
*
353-
* @param parameterDoc the parameter doc
353+
* @param parameterDoc the parameter doc
354354
* @param parameter the parameter
355355
*/
356356
private void setExtensions(io.swagger.v3.oas.annotations.Parameter parameterDoc, Parameter parameter) {
@@ -363,7 +363,7 @@ private void setExtensions(io.swagger.v3.oas.annotations.Parameter parameterDoc,
363363
/**
364364
* Sets parameter explode.
365365
*
366-
* @param parameter the parameter
366+
* @param parameter the parameter
367367
* @param p the p
368368
*/
369369
private void setParameterExplode(Parameter parameter, io.swagger.v3.oas.annotations.Parameter p) {
@@ -380,7 +380,7 @@ else if (Explode.FALSE.equals(p.explode())) {
380380
/**
381381
* Sets parameter style.
382382
*
383-
* @param parameter the parameter
383+
* @param parameter the parameter
384384
* @param p the p
385385
*/
386386
private void setParameterStyle(Parameter parameter, io.swagger.v3.oas.annotations.Parameter p) {
@@ -392,7 +392,7 @@ private void setParameterStyle(Parameter parameter, io.swagger.v3.oas.annotation
392392
/**
393393
* Is explodable boolean.
394394
*
395-
* @param p the p
395+
* @param p the p
396396
* @return the boolean
397397
*/
398398
private boolean isExplodable(io.swagger.v3.oas.annotations.Parameter p) {
@@ -408,7 +408,7 @@ private boolean isExplodable(io.swagger.v3.oas.annotations.Parameter p) {
408408
/**
409409
* Is file boolean.
410410
*
411-
* @param methodParameter the method parameter
411+
* @param methodParameter the method parameter
412412
* @return the boolean
413413
*/
414414
public boolean isFile(MethodParameter methodParameter) {
@@ -434,7 +434,7 @@ public Optional<DelegatingMethodParameterCustomizer> getDelegatingMethodParamete
434434
/**
435435
* Is file boolean.
436436
*
437-
* @param parameterizedType the parameterized type
437+
* @param parameterizedType the parameterized type
438438
* @return the boolean
439439
*/
440440
private boolean isFile(ParameterizedType parameterizedType) {

0 commit comments

Comments
 (0)