+ various javadoc improvements

This commit is contained in:
costin
2010-07-16 15:12:31 +03:00
parent a7553c1a76
commit 13258143f0
10 changed files with 51 additions and 11 deletions

View File

@@ -16,7 +16,7 @@
</scm>
<organization>
<name>SpringSource, a division of VMware</name>
<url>www.SpringSource.org</url>
<url>http://www.SpringSource.org</url>
</organization>
<inceptionYear>2010</inceptionYear>
@@ -255,7 +255,7 @@ limitations under the License.
<groups>
<group>
<title>Spring GemFire Core</title>
<packages>org.springframework.data.gemfire.*</packages>
<packages>org.springframework.data.gemfire*</packages>
</group>
<group>
<title>Spring GemFire Samples</title>
@@ -270,7 +270,7 @@ limitations under the License.
<show>protected</show>
<source>1.5</source>
<links>
<link>http://java.sun.com/j2se/1.5.0/docs/api/</link>
<link>http://java.sun.com/j2se/1.6.0/docs/api/</link>
<link>
http://static.springsource.org/spring/docs/3.0.x/javadoc-api/
</link>
@@ -280,6 +280,7 @@ limitations under the License.
<link>http://logging.apache.org/log4j/docs/api/</link>
<link>http://jakarta.apache.org/commons/logging/apidocs/</link>
<link>http://junit.sourceforge.net/javadoc/</link>
<link>http://atinject.googlecode.com/svn/trunk/javadoc/</link>
</links>
</configuration>
</plugin>

View File

@@ -137,7 +137,7 @@ public class GemfireTemplate extends GemfireAccessor {
* Create a close-suppressing proxy for the given GemFire {@link Region}.
* Called by the <code>execute</code> method.
*
* @param pm the GemFire Region to create a proxy for
* @param region the GemFire Region to create a proxy for
* @return the Region proxy, implementing all interfaces
* implemented by the passed-in Region object
* @see Region#close()

View File

@@ -230,7 +230,7 @@ public class RegionFactoryBean<K, V> implements DisposableBean, FactoryBean<Regi
* Sets the data policy. Used only when a new region is created.
* Overrides the settings specified through {@link #setAttributes(RegionAttributes)}.
*
* @param scope
* @param dataPolicy the region data policy
*/
public void setDataPolicy(DataPolicy dataPolicy) {
this.dataPolicy = dataPolicy;

View File

@@ -0,0 +1,14 @@
/**
*
* Package providing integration of
* <a href="http://www.gemstone.com/products/gemfire">GemFire</a>
* with Spring concepts.
*
* <p/>Contains helper classes, a tempalte plus callback for GemFire
* access and an implementation of Spring's transaction SPI for local
* GemFire transactions.
*
*/
package org.springframework.data.gemfire;

View File

@@ -35,7 +35,7 @@ import com.gemstone.gemfire.DataSerializable;
import com.gemstone.gemfire.Instantiator;
/**
* ASM based {@link InstantiatorFactory} implementation. This class relies on ASM 2.x package
* ASM based {@link InstantiatorGenerator} implementation. This class relies on ASM 2.x package
* repacked by Spring framework to minimize the number of dependencies and avoid any versioning
* confusion.
*

View File

@@ -110,7 +110,7 @@ public class InstantiatorFactoryBean implements BeanClassLoaderAware, FactoryBea
* Sets the auto-registration of this {@link Instantiator} during the container startup.
* Default is true, meaning the registration will occur once this factory is initialized.
*
* @see #register(Instantiator)
* @see Instantiator#register(Instantiator)
* @param autoRegister the autoRegister to set
*/
public void setAutoRegister(boolean autoRegister) {

View File

@@ -29,8 +29,10 @@ public interface InstantiatorGenerator {
/**
* Returns a (potentially new) Instantiator that optimizes the instantiation of the given types.
*
* @return
*
* @param clazz class produced by the instantiator
* @param classId instantiator class id
* @return an instantiator optimized for the given type.
*/
Instantiator getInstantiator(Class<? extends DataSerializable> clazz, int classId);
}

View File

@@ -0,0 +1,9 @@
/**
*
* Classes supporting the <code>org.springframework.data.gemfire</code> package.
* Provides various serialization helpers.
*
*/
package org.springframework.data.gemfire.serialization;

View File

@@ -6,12 +6,19 @@
<!-- all beans are lazy to allow the same config to be used between multiple tests -->
<!-- as there can be only one cache per VM -->
<bean id="default-cache" class="org.springframework.data.gemfire.CacheFactoryBean"/>
<bean id="default-cache" class="org.springframework.data.gemfire.CacheFactoryBean">
<property name="properties">
<props>
<prop key="log-level">warning</prop>
</props>
</property>
</bean>
<bean id="cache-with-props" class="org.springframework.data.gemfire.CacheFactoryBean">
<property name="properties">
<props>
<prop key="name">cache-with-props</prop>
<prop key="log-level">warning</prop>
</props>
</property>
</bean>
@@ -20,6 +27,7 @@
<property name="properties">
<props>
<prop key="name">cache-with-props</prop>
<prop key="log-level">warning</prop>
</props>
</property>
</bean>

View File

@@ -6,7 +6,13 @@
<!-- all beans are lazy to allow the same config to be used between multiple tests -->
<!-- as there can be only one cache per VM -->
<bean id="cache" class="org.springframework.data.gemfire.CacheFactoryBean"/>
<bean id="cache" class="org.springframework.data.gemfire.CacheFactoryBean">
<property name="properties">
<props>
<prop key="log-level">warning</prop>
</props>
</property>
</bean>
<bean id="basic" class="org.springframework.data.gemfire.RegionFactoryBean" p:cache-ref="cache" p:name="basic"/>