Skip to content

Commit 3943d1c

Browse files
jminiwing328
jmini
authored and
wing328
committed
[java] fix javadoc configuration (#3302)
* [java] fix javadoc configuration * [java-pkmst-microservice] fix generated javadoc
1 parent 3f9e374 commit 3943d1c

File tree

20 files changed

+94
-69
lines changed

20 files changed

+94
-69
lines changed

‎CI/circle_parallel.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ if [ "$NODE_INDEX" = "1" ]; then
1212
#cp CI/pom.xml.circleci pom.xml
1313
java -version
1414
mvn --quiet verify -Psamples.circleci
15+
mvn --quiet javadoc:javadoc -Psamples.circleci
1516

1617
# generate all petstore samples (client, servers, doc)
1718
./bin/run-all-petstore

‎modules/openapi-generator/src/main/resources/Java/libraries/jersey2/build.gradle.mustache

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,7 @@ dependencies {
161161
{{/java8}}
162162
testCompile "junit:junit:$junit_version"
163163
}
164+
165+
javadoc {
166+
options.tags = [ "http.response.details:a:Http Response Details" ]
167+
}

‎modules/openapi-generator/src/main/resources/Java/libraries/jersey2/pom.mustache

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -170,17 +170,17 @@
170170
<goals>
171171
<goal>jar</goal>
172172
</goals>
173-
<configuration>
174-
<tags>
175-
<tag>
176-
<name>http.response.details</name>
177-
<placement>a</placement>
178-
<head>Http Response Details:</head>
179-
</tag>
180-
</tags>
181-
</configuration>
182173
</execution>
183174
</executions>
175+
<configuration>
176+
<tags>
177+
<tag>
178+
<name>http.response.details</name>
179+
<placement>a</placement>
180+
<head>Http Response Details:</head>
181+
</tag>
182+
</tags>
183+
</configuration>
184184
</plugin>
185185
<plugin>
186186
<groupId>org.apache.maven.plugins</groupId>

‎modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/build.gradle.mustache

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,7 @@ dependencies {
143143
{{/threetenbp}}
144144
testCompile 'junit:junit:4.12'
145145
}
146+
147+
javadoc {
148+
options.tags = [ "http.response.details:a:Http Response Details" ]
149+
}

‎modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/pom.mustache

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -149,17 +149,17 @@
149149
<goals>
150150
<goal>jar</goal>
151151
</goals>
152-
<configuration>
153-
<tags>
154-
<tag>
155-
<name>http.response.details</name>
156-
<placement>a</placement>
157-
<head>Http Response Details:</head>
158-
</tag>
159-
</tags>
160-
</configuration>
161152
</execution>
162153
</executions>
154+
<configuration>
155+
<tags>
156+
<tag>
157+
<name>http.response.details</name>
158+
<placement>a</placement>
159+
<head>Http Response Details:</head>
160+
</tag>
161+
</tags>
162+
</configuration>
163163
</plugin>
164164
<plugin>
165165
<groupId>org.apache.maven.plugins</groupId>

‎modules/openapi-generator/src/main/resources/java-pkmst/config/appconfig.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public class AppConfig extends WebMvcConfigurerAdapter {
8787
* .exposedHeaders("header1", "header2")
8888
* .allowCredentials(false).maxAge(3600);
8989
*
90-
* @return
90+
* @return a new WebMvcConfigurer instance
9191
*/
9292
@Bean
9393
public WebMvcConfigurer corsConfigurer() {

‎modules/openapi-generator/src/main/resources/java-pkmst/security/oAuth2SecurityConfiguration.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import org.springframework.security.oauth2.provider.request.DefaultOAuth2Request
1818
import org.springframework.security.oauth2.provider.token.TokenStore;
1919
import org.springframework.security.oauth2.provider.token.store.InMemoryTokenStore;
2020
/**
21-
* Provides a convenient base class for creating a {@link WebSecurityConfigurer}
21+
* Provides a convenient base class for creating a WebSecurityConfigurer
2222
* instance. The implementation allows customization by overriding methods.
2323
*
2424
* @see EnableWebSecurity

‎modules/openapi-generator/src/main/resources/java-pkmst/security/resourceServerConfiguration.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import org.springframework.http.HttpMethod;
1010
/**
1111
* Configurer class for <code>@EnableResourceServer</code> classes. This class adjust the access
1212
* rules and paths that are protected by OAuth2 security. If more than one configures the same property, then the last
13-
* one wins. The configurers are sorted by {@link Order} before being applied.
13+
* one wins. The configurers are sorted by Order before being applied.
1414
*
1515
* @author pkmst
1616
*

‎samples/client/petstore/java/jersey2-java6/pom.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,17 +151,17 @@
151151
<goals>
152152
<goal>jar</goal>
153153
</goals>
154-
<configuration>
155-
<tags>
156-
<tag>
157-
<name>http.response.details</name>
158-
<placement>a</placement>
159-
<head>Http Response Details:</head>
160-
</tag>
161-
</tags>
162-
</configuration>
163154
</execution>
164155
</executions>
156+
<configuration>
157+
<tags>
158+
<tag>
159+
<name>http.response.details</name>
160+
<placement>a</placement>
161+
<head>Http Response Details:</head>
162+
</tag>
163+
</tags>
164+
</configuration>
165165
</plugin>
166166
<plugin>
167167
<groupId>org.apache.maven.plugins</groupId>

‎samples/client/petstore/java/jersey2-java8/build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,7 @@ dependencies {
112112
compile "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson_version"
113113
testCompile "junit:junit:$junit_version"
114114
}
115+
116+
javadoc {
117+
options.tags = [ "http.response.details:a:Http Response Details" ]
118+
}

‎samples/client/petstore/java/jersey2-java8/pom.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,17 +151,17 @@
151151
<goals>
152152
<goal>jar</goal>
153153
</goals>
154-
<configuration>
155-
<tags>
156-
<tag>
157-
<name>http.response.details</name>
158-
<placement>a</placement>
159-
<head>Http Response Details:</head>
160-
</tag>
161-
</tags>
162-
</configuration>
163154
</execution>
164155
</executions>
156+
<configuration>
157+
<tags>
158+
<tag>
159+
<name>http.response.details</name>
160+
<placement>a</placement>
161+
<head>Http Response Details:</head>
162+
</tag>
163+
</tags>
164+
</configuration>
165165
</plugin>
166166
<plugin>
167167
<groupId>org.apache.maven.plugins</groupId>

‎samples/client/petstore/java/jersey2/build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,7 @@ dependencies {
114114
compile "com.brsanthu:migbase64:2.2"
115115
testCompile "junit:junit:$junit_version"
116116
}
117+
118+
javadoc {
119+
options.tags = [ "http.response.details:a:Http Response Details" ]
120+
}

‎samples/client/petstore/java/jersey2/pom.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,17 +151,17 @@
151151
<goals>
152152
<goal>jar</goal>
153153
</goals>
154-
<configuration>
155-
<tags>
156-
<tag>
157-
<name>http.response.details</name>
158-
<placement>a</placement>
159-
<head>Http Response Details:</head>
160-
</tag>
161-
</tags>
162-
</configuration>
163154
</execution>
164155
</executions>
156+
<configuration>
157+
<tags>
158+
<tag>
159+
<name>http.response.details</name>
160+
<placement>a</placement>
161+
<head>Http Response Details:</head>
162+
</tag>
163+
</tags>
164+
</configuration>
165165
</plugin>
166166
<plugin>
167167
<groupId>org.apache.maven.plugins</groupId>

‎samples/client/petstore/java/okhttp-gson-parcelableModel/build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,7 @@ dependencies {
108108
compile 'org.threeten:threetenbp:1.3.5'
109109
testCompile 'junit:junit:4.12'
110110
}
111+
112+
javadoc {
113+
options.tags = [ "http.response.details:a:Http Response Details" ]
114+
}

‎samples/client/petstore/java/okhttp-gson-parcelableModel/pom.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,17 +142,17 @@
142142
<goals>
143143
<goal>jar</goal>
144144
</goals>
145-
<configuration>
146-
<tags>
147-
<tag>
148-
<name>http.response.details</name>
149-
<placement>a</placement>
150-
<head>Http Response Details:</head>
151-
</tag>
152-
</tags>
153-
</configuration>
154145
</execution>
155146
</executions>
147+
<configuration>
148+
<tags>
149+
<tag>
150+
<name>http.response.details</name>
151+
<placement>a</placement>
152+
<head>Http Response Details:</head>
153+
</tag>
154+
</tags>
155+
</configuration>
156156
</plugin>
157157
<plugin>
158158
<groupId>org.apache.maven.plugins</groupId>

‎samples/client/petstore/java/okhttp-gson/build.gradle

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,7 @@ dependencies {
108108
compile 'org.threeten:threetenbp:1.3.5'
109109
testCompile 'junit:junit:4.12'
110110
}
111+
112+
javadoc {
113+
options.tags = [ "http.response.details:a:Http Response Details" ]
114+
}

‎samples/client/petstore/java/okhttp-gson/pom.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,17 +142,17 @@
142142
<goals>
143143
<goal>jar</goal>
144144
</goals>
145-
<configuration>
146-
<tags>
147-
<tag>
148-
<name>http.response.details</name>
149-
<placement>a</placement>
150-
<head>Http Response Details:</head>
151-
</tag>
152-
</tags>
153-
</configuration>
154145
</execution>
155146
</executions>
147+
<configuration>
148+
<tags>
149+
<tag>
150+
<name>http.response.details</name>
151+
<placement>a</placement>
152+
<head>Http Response Details:</head>
153+
</tag>
154+
</tags>
155+
</configuration>
156156
</plugin>
157157
<plugin>
158158
<groupId>org.apache.maven.plugins</groupId>

‎samples/server/petstore/java-pkmst/src/main/java/com/prokarma/pkmst/config/AppConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public class AppConfig extends WebMvcConfigurerAdapter {
2020
* .exposedHeaders("header1", "header2")
2121
* .allowCredentials(false).maxAge(3600);
2222
*
23-
* @return
23+
* @return a new WebMvcConfigurer instance
2424
*/
2525
@Bean
2626
public WebMvcConfigurer corsConfigurer() {

‎samples/server/petstore/java-pkmst/src/main/java/com/prokarma/pkmst/security/OAuth2SecurityConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import org.springframework.security.oauth2.provider.token.TokenStore;
1919
import org.springframework.security.oauth2.provider.token.store.InMemoryTokenStore;
2020
/**
21-
* Provides a convenient base class for creating a {@link WebSecurityConfigurer}
21+
* Provides a convenient base class for creating a WebSecurityConfigurer
2222
* instance. The implementation allows customization by overriding methods.
2323
*
2424
* @see EnableWebSecurity

‎samples/server/petstore/java-pkmst/src/main/java/com/prokarma/pkmst/security/ResourceServerConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/**
1111
* Configurer class for <code>@EnableResourceServer</code> classes. This class adjust the access
1212
* rules and paths that are protected by OAuth2 security. If more than one configures the same property, then the last
13-
* one wins. The configurers are sorted by {@link Order} before being applied.
13+
* one wins. The configurers are sorted by Order before being applied.
1414
*
1515
* @author pkmst
1616
*

0 commit comments

Comments
 (0)