Skip to content

Commit 85e3dbe

Browse files
committed
Javadoc / Copyright update
1 parent c9d36fd commit 85e3dbe

File tree

215 files changed

+4950
-3420
lines changed

Some content is hidden

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

215 files changed

+4950
-3420
lines changed

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

+17-12
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
* *
44
* * *
55
* * * *
6-
* * * * * Copyright 2019-2024 the original author or authors.
76
* * * * *
8-
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
* * * * * you may not use this file except in compliance with the License.
10-
* * * * * You may obtain a copy of the License at
7+
* * * * * * Copyright 2019-2024 the original author or authors.
8+
* * * * * *
9+
* * * * * * Licensed under the Apache License, Version 2.0 (the "License");
10+
* * * * * * you may not use this file except in compliance with the License.
11+
* * * * * * You may obtain a copy of the License at
12+
* * * * * *
13+
* * * * * * https://www.apache.org/licenses/LICENSE-2.0
14+
* * * * * *
15+
* * * * * * Unless required by applicable law or agreed to in writing, software
16+
* * * * * * distributed under the License is distributed on an "AS IS" BASIS,
17+
* * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* * * * * * See the License for the specific language governing permissions and
19+
* * * * * * limitations under the License.
1120
* * * * *
12-
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13-
* * * * *
14-
* * * * * Unless required by applicable law or agreed to in writing, software
15-
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
* * * * * See the License for the specific language governing permissions and
18-
* * * * * limitations under the License.
1921
* * * *
2022
* * *
2123
* *
22-
*
24+
*
2325
*/
2426

2527
package org.springdoc.api;
@@ -718,6 +720,7 @@ else if (routerOperation.getOperationModel() != null && StringUtils.isNotBlank(r
718720
*
719721
* @param routerOperation the router operation
720722
* @param locale the locale
723+
* @param openAPI the open api
721724
*/
722725
protected void calculatePath(RouterOperation routerOperation, Locale locale, OpenAPI openAPI) {
723726
routerOperation = customizeDataRestRouterOperation(routerOperation);
@@ -789,7 +792,9 @@ private RouterOperation customizeDataRestRouterOperation(RouterOperation routerO
789792
* @param consumes the consumes
790793
* @param produces the produces
791794
* @param headers the headers
795+
* @param params the params
792796
* @param locale the locale
797+
* @param openAPI the open api
793798
*/
794799
protected void calculatePath(HandlerMethod handlerMethod, String operationPath,
795800
Set<RequestMethod> requestMethods, String[] consumes, String[] produces, String[] headers, String[] params, Locale locale, OpenAPI openAPI) {

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/ErrorMessage.java

+14-12
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
* *
44
* * *
55
* * * *
6-
* * * * * Copyright 2019-2024 the original author or authors.
76
* * * * *
8-
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
* * * * * you may not use this file except in compliance with the License.
10-
* * * * * You may obtain a copy of the License at
7+
* * * * * * Copyright 2019-2024 the original author or authors.
8+
* * * * * *
9+
* * * * * * Licensed under the Apache License, Version 2.0 (the "License");
10+
* * * * * * you may not use this file except in compliance with the License.
11+
* * * * * * You may obtain a copy of the License at
12+
* * * * * *
13+
* * * * * * https://www.apache.org/licenses/LICENSE-2.0
14+
* * * * * *
15+
* * * * * * Unless required by applicable law or agreed to in writing, software
16+
* * * * * * distributed under the License is distributed on an "AS IS" BASIS,
17+
* * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* * * * * * See the License for the specific language governing permissions and
19+
* * * * * * limitations under the License.
1120
* * * * *
12-
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13-
* * * * *
14-
* * * * * Unless required by applicable law or agreed to in writing, software
15-
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
* * * * * See the License for the specific language governing permissions and
18-
* * * * * limitations under the License.
1921
* * * *
2022
* * *
2123
* *
22-
*
24+
*
2325
*/
2426

2527
package org.springdoc.api;

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/OpenApiResourceNotFoundException.java

+15-12
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,32 @@
33
* *
44
* * *
55
* * * *
6-
* * * * * Copyright 2019-2024 the original author or authors.
76
* * * * *
8-
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
* * * * * you may not use this file except in compliance with the License.
10-
* * * * * You may obtain a copy of the License at
7+
* * * * * * Copyright 2019-2024 the original author or authors.
8+
* * * * * *
9+
* * * * * * Licensed under the Apache License, Version 2.0 (the "License");
10+
* * * * * * you may not use this file except in compliance with the License.
11+
* * * * * * You may obtain a copy of the License at
12+
* * * * * *
13+
* * * * * * https://www.apache.org/licenses/LICENSE-2.0
14+
* * * * * *
15+
* * * * * * Unless required by applicable law or agreed to in writing, software
16+
* * * * * * distributed under the License is distributed on an "AS IS" BASIS,
17+
* * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* * * * * * See the License for the specific language governing permissions and
19+
* * * * * * limitations under the License.
1120
* * * * *
12-
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13-
* * * * *
14-
* * * * * Unless required by applicable law or agreed to in writing, software
15-
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
* * * * * See the License for the specific language governing permissions and
18-
* * * * * limitations under the License.
1921
* * * *
2022
* * *
2123
* *
22-
*
24+
*
2325
*/
2426

2527
package org.springdoc.api;
2628

2729
/**
2830
* The type Open api resource not found exception.
31+
*
2932
* @author bnasslahsen
3033
*/
3134
public class OpenApiResourceNotFoundException extends RuntimeException {

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/annotations/ParameterObject.java

+15-12
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
* *
44
* * *
55
* * * *
6-
* * * * * Copyright 2019-2024 the original author or authors.
76
* * * * *
8-
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
* * * * * you may not use this file except in compliance with the License.
10-
* * * * * You may obtain a copy of the License at
7+
* * * * * * Copyright 2019-2024 the original author or authors.
8+
* * * * * *
9+
* * * * * * Licensed under the Apache License, Version 2.0 (the "License");
10+
* * * * * * you may not use this file except in compliance with the License.
11+
* * * * * * You may obtain a copy of the License at
12+
* * * * * *
13+
* * * * * * https://www.apache.org/licenses/LICENSE-2.0
14+
* * * * * *
15+
* * * * * * Unless required by applicable law or agreed to in writing, software
16+
* * * * * * distributed under the License is distributed on an "AS IS" BASIS,
17+
* * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* * * * * * See the License for the specific language governing permissions and
19+
* * * * * * limitations under the License.
1120
* * * * *
12-
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13-
* * * * *
14-
* * * * * Unless required by applicable law or agreed to in writing, software
15-
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
* * * * * See the License for the specific language governing permissions and
18-
* * * * * limitations under the License.
1921
* * * *
2022
* * *
2123
* *
22-
*
24+
*
2325
*/
2426

2527
package org.springdoc.core.annotations;
@@ -31,6 +33,7 @@
3133

3234
/**
3335
* The interface Parameter object.
36+
*
3437
* @author bnasslahsen
3538
*/
3639
@Target({ ElementType.PARAMETER, ElementType.TYPE })

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/annotations/RouterOperation.java

+24-12
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
* *
44
* * *
55
* * * *
6-
* * * * * Copyright 2019-2024 the original author or authors.
76
* * * * *
8-
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
* * * * * you may not use this file except in compliance with the License.
10-
* * * * * You may obtain a copy of the License at
7+
* * * * * * Copyright 2019-2024 the original author or authors.
8+
* * * * * *
9+
* * * * * * Licensed under the Apache License, Version 2.0 (the "License");
10+
* * * * * * you may not use this file except in compliance with the License.
11+
* * * * * * You may obtain a copy of the License at
12+
* * * * * *
13+
* * * * * * https://www.apache.org/licenses/LICENSE-2.0
14+
* * * * * *
15+
* * * * * * Unless required by applicable law or agreed to in writing, software
16+
* * * * * * distributed under the License is distributed on an "AS IS" BASIS,
17+
* * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* * * * * * See the License for the specific language governing permissions and
19+
* * * * * * limitations under the License.
1120
* * * * *
12-
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13-
* * * * *
14-
* * * * * Unless required by applicable law or agreed to in writing, software
15-
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
* * * * * See the License for the specific language governing permissions and
18-
* * * * * limitations under the License.
1921
* * * *
2022
* * *
2123
* *
22-
*
24+
*
2325
*/
2426

2527
package org.springdoc.core.annotations;
@@ -48,13 +50,15 @@
4850
/**
4951
* The path mapping URIs (e.g. {@code "/profile"}).
5052
* Path mapping URIs may contain placeholders (e.g. <code>"/${profile_path}"</code>).
53+
*
5154
* @return the string
5255
*/
5356
String path() default "";
5457

5558
/**
5659
* The HTTP request methods to map to, narrowing the primary mapping:
5760
* GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.
61+
*
5862
* @return the request method [ ]
5963
*/
6064
RequestMethod[] method() default {};
@@ -68,6 +72,7 @@
6872
* consumes = {"text/plain", "application/*"}
6973
* consumes = MediaType.TEXT_PLAIN_VALUE
7074
* </pre>
75+
*
7176
* @return the string [ ]
7277
*/
7378
String[] consumes() default {};
@@ -84,6 +89,7 @@
8489
* produces = MediaType.TEXT_PLAIN_VALUE
8590
* produces = "text/plain;charset=UTF-8"
8691
* </pre>
92+
*
8793
* @return the string [ ]
8894
*/
8995
String[] produces() default {};
@@ -93,6 +99,7 @@
9399
* <p>Same format for any environment: a sequence of "My-Header=myValue" style
94100
* expressions, with a request only mapped if each such header is found
95101
* to have the given value.
102+
*
96103
* @return the string [ ]
97104
*/
98105
String[] headers() default {};
@@ -101,31 +108,36 @@
101108
* The parameters of the mapped request, narrowing the primary mapping.
102109
* Same format for any environment: a sequence of "myParam=myValue" style expressions,
103110
* with a request only mapped if each such parameter is found to have the given value.
111+
*
104112
* @return the string [ ]
105113
*/
106114
String[] params() default {};
107115

108116
/**
109117
* The class of the Handler bean.
118+
*
110119
* @return the class of the Bean
111120
*/
112121
Class<?> beanClass() default Void.class;
113122

114123
/**
115124
* The method of the handler Bean.
125+
*
116126
* @return The method of the handler Bean.
117127
*/
118128
String beanMethod() default "";
119129

120130
/**
121131
* The parameters of the handler method.
132+
*
122133
* @return The parameters of the handler method.
123134
*/
124135
Class<?>[] parameterTypes() default {};
125136

126137
/**
127138
* The swagger operation description
128139
* Alias for {@link Operation}.
140+
*
129141
* @return The operation
130142
*/
131143
Operation operation() default @Operation();

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/annotations/RouterOperations.java

+15-13
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
* *
44
* * *
55
* * * *
6-
* * * * * Copyright 2019-2024 the original author or authors.
76
* * * * *
8-
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9-
* * * * * you may not use this file except in compliance with the License.
10-
* * * * * You may obtain a copy of the License at
7+
* * * * * * Copyright 2019-2024 the original author or authors.
8+
* * * * * *
9+
* * * * * * Licensed under the Apache License, Version 2.0 (the "License");
10+
* * * * * * you may not use this file except in compliance with the License.
11+
* * * * * * You may obtain a copy of the License at
12+
* * * * * *
13+
* * * * * * https://www.apache.org/licenses/LICENSE-2.0
14+
* * * * * *
15+
* * * * * * Unless required by applicable law or agreed to in writing, software
16+
* * * * * * distributed under the License is distributed on an "AS IS" BASIS,
17+
* * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18+
* * * * * * See the License for the specific language governing permissions and
19+
* * * * * * limitations under the License.
1120
* * * * *
12-
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13-
* * * * *
14-
* * * * * Unless required by applicable law or agreed to in writing, software
15-
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16-
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17-
* * * * * See the License for the specific language governing permissions and
18-
* * * * * limitations under the License.
1921
* * * *
2022
* * *
2123
* *
22-
*
24+
*
2325
*/
2426

2527
package org.springdoc.core.annotations;
@@ -36,7 +38,7 @@
3638
* Container for repeatable {@link RouterOperation} annotation
3739
*
3840
* @author bnasslahsen
39-
* @see RouterOperation
41+
* @see RouterOperation
4042
*/
4143
@Target({ METHOD, ANNOTATION_TYPE })
4244
@Retention(RetentionPolicy.RUNTIME)

0 commit comments

Comments
 (0)