Eliminate all Javadoc warnings
- Support external Javadoc links using Gradle's javadoc.options.links - Fix all other Javadoc warnings, such as typos, references to non-existent (or no longer existent) types and members, etc, including changes related to the Quartz 2.0 upgrade (SPR-8275) and adding the HTTP PATCH method (SPR-7985). - Suppress all output for project-level `javadoc` tasks in order to hide false-negative warnings about cross-module @see and @link references (e.g. spring-core having a @see reference to spring-web). Use the `--info` (-i) flag to gradle at any time to see project-level javadoc warnings without running the entire `api` task. e.g. `gradle :spring-core:javadoc -i` - Favor root project level `api` task for detection of legitimate Javadoc warnings. There are now zero Javadoc warnings across the entirety of spring-framework. Goal: keep it that way. - Remove all @link and @see references to types and members that exist only in Servlet <= 2.5 and Hibernate <= 4.0, favoring 3.0+ and 4.0+ respectively. This is necessary because only one version of each of these dependencies can be present on the global `api` javadoc task's classpath. To that end, the `api` task classpath has now been customized to ensure that the Servlet 3 API and Hibernate Core 4 jars have precedence. - SPR-8896 replaced our dependency on aspectjrt with a dependency on aspectjweaver, which is fine from a POM point of view, but causes a spurious warning to be emitted from the ant iajc task that it "cannot find aspectjrt on the classpath" - even though aspectjweaver is perfectly sufficient. In the name of keeping the console quiet, a new `rt` configuration has been added, and aspectjrt added as a dependency to it. In turn, configurations.rt.asPath is appended to the iajc classpath during both compileJava and compileTestJava for spring-aspects. Issue: SPR-10078, SPR-8275, SPR-7985, SPR-8896
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2010 the original author or authors.
|
||||
* Copyright 2002-2012 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -73,7 +73,7 @@ public class FilterDefinitionFactoryBean implements FactoryBean<FilterDefinition
|
||||
static {
|
||||
// Hibernate 3.6 TypeResolver class available?
|
||||
try {
|
||||
Class trClass = FilterDefinitionFactoryBean.class.getClassLoader().loadClass(
|
||||
Class<?> trClass = FilterDefinitionFactoryBean.class.getClassLoader().loadClass(
|
||||
"org.hibernate.type.TypeResolver");
|
||||
heuristicTypeMethod = trClass.getMethod("heuristicType", String.class);
|
||||
typeResolver = trClass.newInstance();
|
||||
@@ -109,7 +109,8 @@ public class FilterDefinitionFactoryBean implements FactoryBean<FilterDefinition
|
||||
/**
|
||||
* Set the parameter types for the filter,
|
||||
* with parameter names as keys and type names as values.
|
||||
* @see org.hibernate.type.TypeFactory#heuristicType(String)
|
||||
* See {@code org.hibernate.type.TypeFactory#heuristicType(String)} (Hibernate 3.x)
|
||||
* or {@code org.hibernate.type.TypeResolver#heuristicType(String)} (Hibernate 4.x)
|
||||
*/
|
||||
public void setParameterTypes(Map<String, String> parameterTypes) {
|
||||
if (parameterTypes != null) {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2008 the original author or authors.
|
||||
* Copyright 2002-2012 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -432,7 +432,6 @@ public abstract class HibernateAccessor implements InitializingBean, BeanFactory
|
||||
* @param ex the SQLException
|
||||
* @return the corresponding DataAccessException instance
|
||||
* @see #setJdbcExceptionTranslator
|
||||
* @see org.hibernate.Session#connection()
|
||||
*/
|
||||
protected DataAccessException convertJdbcAccessException(SQLException ex) {
|
||||
SQLExceptionTranslator translator = getJdbcExceptionTranslator();
|
||||
|
||||
@@ -81,8 +81,6 @@ public interface HibernateOperations {
|
||||
* @return a result object returned by the action, or <code>null</code>
|
||||
* @throws org.springframework.dao.DataAccessException in case of Hibernate errors
|
||||
* @see HibernateTransactionManager
|
||||
* @see org.springframework.dao
|
||||
* @see org.springframework.transaction
|
||||
* @see org.hibernate.Session
|
||||
*/
|
||||
<T> T execute(HibernateCallback<T> action) throws DataAccessException;
|
||||
|
||||
@@ -520,9 +520,9 @@ public class LocalSessionFactoryBean extends AbstractSessionFactoryBean implemen
|
||||
* you can also pass in a list or set of listeners objects as value.
|
||||
* <p>See the Hibernate documentation for further details on listener types
|
||||
* and associated listener interfaces.
|
||||
* <p>See {@code org.hibernate.cfg.Configuration#setListener(String, Object)}
|
||||
* @param eventListeners Map with listener type Strings as keys and
|
||||
* listener objects as values
|
||||
* @see org.hibernate.cfg.Configuration#setListener(String, Object)
|
||||
*/
|
||||
public void setEventListeners(Map<String, Object> eventListeners) {
|
||||
this.eventListeners = eventListeners;
|
||||
|
||||
@@ -67,8 +67,6 @@ public interface JdoOperations {
|
||||
* @return a result object returned by the action, or <code>null</code>
|
||||
* @throws org.springframework.dao.DataAccessException in case of JDO errors
|
||||
* @see JdoTransactionManager
|
||||
* @see org.springframework.dao
|
||||
* @see org.springframework.transaction
|
||||
* @see javax.jdo.PersistenceManager
|
||||
*/
|
||||
<T> T execute(JdoCallback<T> action) throws DataAccessException;
|
||||
|
||||
Reference in New Issue
Block a user