Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links and address warnings for JavaDoc [SPR-17174] #21710

Closed
spring-issuemaster opened this issue Aug 13, 2018 · 1 comment
Closed

Fix broken links and address warnings for JavaDoc [SPR-17174] #21710

spring-issuemaster opened this issue Aug 13, 2018 · 1 comment
Assignees
Milestone

Comments

@spring-issuemaster
Copy link
Collaborator

@spring-issuemaster spring-issuemaster commented Aug 13, 2018

Sam Brannen opened SPR-17174 and commented

Status Quo

Executing gradlew api currently emits the following warnings.

javadoc: warning - Multiple sources of package comments found for package "javax.transaction"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet.http"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet.descriptor"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet.annotation"
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java:339: warning - Tag @linkplain: reference not found: Locale.LanguageRange languages
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java:339: warning - Tag @linkplain: reference not found: Locale.LanguageRange languages
/spring-framework/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolHandler.java:42: warning - Tag @link: reference not found: Messages
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - @propertyDescription is an unknown tag.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - @propertyDescription is an unknown tag.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters.
/spring-framework/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java:151: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters.
/spring-framework/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java:64: warning - Tag @link: reference not found: HttpStatus.Series#CLIENT_ERROR CLIENT_ERROR
/spring-framework/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java:64: warning - Tag @link: reference not found: HttpStatus.Series#SERVER_ERROR SERVER_ERROR
/spring-framework/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java:57: warning - Tag @link: reference not found: HttpMessageConverters
/spring-framework/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java:57: warning - Tag @link: reference not found: HttpStatus.Series#CLIENT_ERROR
/spring-framework/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java:57: warning - Tag @link: reference not found: HttpStatus.Series#SERVER_ERROR
/spring-framework/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java:64: warning - Tag @link: reference not found: HttpStatus.Series#CLIENT_ERROR CLIENT_ERROR
/spring-framework/spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java:64: warning - Tag @link: reference not found: HttpStatus.Series#SERVER_ERROR SERVER_ERROR
/spring-framework/spring-web/src/main/java/org/springframework/web/client/RestTemplate.java:92: warning - Tag @link: reference not found: org.springframework.web.reactive.client.WebClient WebClient
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/socket/client/UndertowWebSocketClient.java:123: warning - #DEFAULT_POOL_BUFFER_SIZE (referenced by @value tag) is an unknown reference.
/spring-framework/spring-core/src/main/java/org/springframework/cglib/proxy/Enhancer.java:772: warning - Tag @link: reference not found: EnhancerFactoryData
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java:339: warning - Tag @linkplain: reference not found: Locale.LanguageRange languages
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java:339: warning - Tag @linkplain: reference not found: Locale.LanguageRange languages
/spring-framework/spring-core/src/main/java/org/springframework/util/function/SingletonSupplier.java:37: warning - Tag @link: reference not found: java.util.function Supplier
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java:88: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java:88: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java:88: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java:88: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-web/src/main/java/org/springframework/web/server/handler/FilteringWebHandler.java:35: warning - Tag @link: reference not found: WebFilters
/spring-framework/spring-web/src/main/java/org/springframework/http/codec/xml/XmlEventDecoder.java:79: warning - Tag @link: reference not found: XMLEvents
/spring-framework/spring-tx/src/main/java/org/springframework/transaction/jta/WebLogicJtaTransactionManager.java:76: warning - Tag @see: reference not found: weblogic.transaction.UserTransaction#begin(String)
/spring-framework/spring-tx/src/main/java/org/springframework/transaction/jta/WebLogicJtaTransactionManager.java:76: warning - Tag @see: reference not found: weblogic.transaction.Transaction#setProperty
/spring-framework/spring-tx/src/main/java/org/springframework/transaction/jta/WebLogicJtaTransactionManager.java:76: warning - Tag @see: reference not found: weblogic.transaction.TransactionManager#forceResume
/spring-framework/spring-tx/src/main/java/org/springframework/transaction/jta/WebLogicJtaTransactionManager.java:76: warning - Tag @see: reference not found: weblogic.transaction.TransactionHelper
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java:64: warning - Tag @link: reference not found: SQLExceptions
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSetMetaData.java:37: warning - Tag @link: reference not found: SQLExceptions
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurer.java:102: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurer.java:102: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurer.java:102: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurer.java:102: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/WebSphereDataSourceAdapter.java:70: warning - Tag @see: reference not found: com.ibm.websphere.rsadapter.JDBCConnectionSpec
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/WebSphereDataSourceAdapter.java:70: warning - Tag @see: reference not found: com.ibm.websphere.rsadapter.WSDataSource#getConnection(com.ibm.websphere.rsadapter.JDBCConnectionSpec)
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/WebSphereDataSourceAdapter.java:135: warning - Tag @see: reference not found: com.ibm.websphere.rsadapter.WSDataSource#getConnection(com.ibm.websphere.rsadapter.JDBCConnectionSpec)
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/WebSphereDataSourceAdapter.java:163: warning - Tag @see: reference not found: com.ibm.websphere.rsadapter.JDBCConnectionSpec
/spring-framework/spring-web/src/main/java/org/springframework/web/server/session/CookieWebSessionIdResolver.java:91: warning - Tag @link: reference not found: ResponseCookie.ResponseCookieBuilder
 ResponseCookieBuilder
/spring-framework/spring-web/src/main/java/org/springframework/web/server/session/CookieWebSessionIdResolver.java:91: warning - Tag @link: reference not found: ResponseCookie.ResponseCookieBuilder#build() build()
/spring-framework/spring-web/src/main/java/org/springframework/web/server/session/CookieWebSessionIdResolver.java:91: warning - Tag @link: reference not found: ResponseCookie.ResponseCookieBuilder
 ResponseCookieBuilder
/spring-framework/spring-web/src/main/java/org/springframework/web/server/session/CookieWebSessionIdResolver.java:91: warning - Tag @link: reference not found: ResponseCookie.ResponseCookieBuilder#build() build()
/spring-framework/spring-web/src/main/java/org/springframework/http/server/reactive/HttpHandler.java:43: warning - Tag @link: reference not found: org.springframework.web.server
/spring-framework/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyCodec.java:41: warning - Tag @link: reference not found: Messages
/spring-framework/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyCodec.java:41: warning - Tag @link: reference not found: Messages
/spring-framework/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyCodec.java:41: warning - Tag @link: reference not found: Messages
/spring-framework/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyCodec.java:41: warning - Tag @link: reference not found: Messages
/spring-framework/spring-web/src/main/java/org/springframework/http/client/InterceptingClientHttpRequestFactory.java:34: warning - Tag @link: reference not found: ClientHttpRequestInterceptors
/spring-framework/spring-web/src/main/java/org/springframework/http/client/OkHttp3ClientHttpRequestFactory.java:78: warning - Tag @see: reference not found: OkHttpClient.Builder#readTimeout(long, TimeUnit)
/spring-framework/spring-web/src/main/java/org/springframework/http/client/OkHttp3ClientHttpRequestFactory.java:89: warning - Tag @see: reference not found: OkHttpClient.Builder#writeTimeout(long, TimeUnit)
/spring-framework/spring-web/src/main/java/org/springframework/http/client/OkHttp3ClientHttpRequestFactory.java:100: warning - Tag @see: reference not found: OkHttpClient.Builder#connectTimeout(long, TimeUnit)
/spring-framework/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/TransportHandlingSockJsService.java:66: warning - Tag @link: reference not found: TransportHandlers
/spring-framework/spring-core/src/main/java/org/springframework/cglib/core/AbstractClassGenerator.java:245: warning - Tag @see cannot be used in inline documentation.  It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
/spring-framework/spring-core/src/main/java/org/springframework/cglib/core/AbstractClassGenerator.java:245: warning - Tag @see cannot be used in inline documentation.  It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
/spring-framework/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java:369: warning - Tag @link: reference not found: WebClient.Builder
/spring-framework/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java:369: warning - Tag @link: reference not found: WebClient.Builder
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/HandlerExceptionResolverComposite.java:35: warning - Tag @link: reference not found: HandlerExceptionResolvers
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:48: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:48: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:58: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:58: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:73: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:73: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:48: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:48: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:58: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:58: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:73: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:73: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:90: warning - Tag @link: reference not found: JsonFormat.Parser
/spring-framework/spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java:90: warning - Tag @link: reference not found: JsonFormat.Printer
/spring-framework/spring-context/src/main/java/org/springframework/context/support/ResourceBundleMessageSource.java:79: warning - Tag @link: reference not found: ResourceBundle.Control
/spring-framework/spring-context/src/main/java/org/springframework/context/support/ResourceBundleMessageSource.java:283: warning - Tag @link: reference not found: ResourceBundle.Control
/spring-framework/spring-context/src/main/java/org/springframework/context/support/ResourceBundleMessageSource.java:305: warning - Tag @link: reference not found: ResourceBundle.Control
/spring-framework/spring-web/src/main/java/org/springframework/http/client/InterceptingClientHttpRequestFactory.java:34: warning - Tag @link: reference not found: ClientHttpRequestInterceptors
/spring-framework/spring-web/src/main/java/org/springframework/http/codec/xml/XmlEventDecoder.java:79: warning - Tag @link: reference not found: XMLEvents
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java:64: warning - Tag @link: reference not found: SQLExceptions
/spring-framework/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSetMetaData.java:37: warning - Tag @link: reference not found: SQLExceptions
/spring-framework/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java:369: warning - Tag @link: reference not found: WebClient.Builder
/spring-framework/spring-core/src/main/java/org/springframework/util/function/SingletonSupplier.java:37: warning - Tag @link: reference not found: java.util.function Supplier
/spring-framework/spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java:57: warning - Tag @link: reference not found: HttpMessageConverters
/spring-framework/spring-web/src/main/java/org/springframework/web/server/handler/FilteringWebHandler.java:35: warning - Tag @link: reference not found: WebFilters
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/HandlerExceptionResolverComposite.java:35: warning - Tag @link: reference not found: HandlerExceptionResolvers
/spring-framework/spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurer.java:102: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java:88: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java:88: warning - Tag @link: reference not found: Formatters
/spring-framework/spring-web/src/main/java/org/springframework/http/codec/xml/XmlEventDecoder.java:79: warning - Tag @link: reference not found: XMLEvents
100 warnings

BUILD SUCCESSFUL in 1m 32s

Deliverables

  1. Fix broken links in JavaDoc
  2. Address remaining warnings if possible

Affects: 5.0.8, 5.1 RC1

@spring-issuemaster
Copy link
Collaborator Author

@spring-issuemaster spring-issuemaster commented Aug 16, 2018

Juergen Hoeller commented

I've addressed all recent javadoc errors. There are still a few oldies there that we don't care about, like these strange JavaFX warnings (??) and the missing references to vendor classes in @see tags, plus a few coming from repackaged classes that we don't actively polish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.