[infinispan-commits] Infinispan SVN: r1155 - trunk/core/src/main/java/org/infinispan/config.

[infinispan-commits at lists.jboss.org]

Author: manik.surtani at jboss.com
Date: 2009-11-12 12:13:35 -0500 (Thu, 12 Nov 2009)
New Revision: 1155

Modified:
   trunk/core/src/main/java/org/infinispan/config/Configuration.java
Log:
Better config docs

Modified: trunk/core/src/main/java/org/infinispan/config/Configuration.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/Configuration.java	2009-11-12 17:05:30 UTC (rev 1154)
+++ trunk/core/src/main/java/org/infinispan/config/Configuration.java	2009-11-12 17:13:35 UTC (rev 1155)
@@ -57,9 +57,10 @@
  * @configRef name="default",desc="Configures the default cache which can be retrieved via CacheManager.getCache().
  *                                 These default settings are also used as a starting point when configuring namedCaches,
  *                                 since the default settings are inherited by any named cache."
- * @configRef name="namedCache",desc="Configures a named cache whose name can be passed to CacheManager.getCache(String)
+ * @configRef name="namedCache",desc="  If you use <namedCache ... > instead of <default ... > this defines a
+ *                                    a named cache whose name can be passed to CacheManager.getCache(String)
  *                                    in order to retrieve the named instance.  Named caches inherit settings from the
- *                                    default, and additional behavior can be specified or overridden."
+ *                                    default, and additional behavior can be specified or overridden.  Also the 'name' attribute is mandatory."
  * 
  * @author <a href="mailto:manik at jboss.org">Manik Surtani (manik at jboss.org)</a>
  * @author Vladimir Blagojevic