svn commit: r1160860 - /wicket/trunk/wicket-core/src/main/java/org/apache/wicket/MetaDataKey.java

[svenmeier]

Author: svenmeier
Date: Tue Aug 23 19:24:28 2011
New Revision: 1160860

URL: http://svn.apache.org/viewvc?rev=1160860&view=rev
Log:
fixed javadoc for generics parameter

Modified:
    wicket/trunk/wicket-core/src/main/java/org/apache/wicket/MetaDataKey.java

Modified: 
wicket/trunk/wicket-core/src/main/java/org/apache/wicket/MetaDataKey.java
URL: 
http://svn.apache.org/viewvc/wicket/trunk/wicket-core/src/main/java/org/apache/wicket/MetaDataKey.java?rev=1160860&r1=1160859&r2=1160860&view=diff
==============================================================================
--- wicket/trunk/wicket-core/src/main/java/org/apache/wicket/MetaDataKey.java 
(original)
+++ wicket/trunk/wicket-core/src/main/java/org/apache/wicket/MetaDataKey.java 
Tue Aug 23 19:24:28 2011
@@ -18,17 +18,27 @@ package org.apache.wicket;
 
 
 /**
- * A key to a piece of metadata associated with a Component at runtime. The 
key contains type
- * information that can be used to check the type of any metadata value for 
the key when the value
- * is set on the given Component. MetaDataKey is abstract in order to force 
the creation of a
- * subtype. That subtype is used to test for identity when looking for the 
metadata because actual
- * object identity would suffer from problems under serialization. So, the 
correct way to declare a
- * MetaDataKey is like this: public static MetaDataKey ROLE = new 
MetaDataKey(Role.class) { }
+ * A key to a piece of metadata associated with a {@link Component}, {@link 
Session} or
+ * {@link Application} at runtime. The key contains type information that can 
be used to check the
+ * type of any metadata value for the key when the value is set. MetaDataKey 
is abstract in order to
+ * force the creation of a subtype. That subtype is used to test for identity 
when looking for the
+ * metadata because actual object identity would suffer from problems under 
serialization. So, the
+ * correct way to declare a MetaDataKey is like this:
+ * 
+ * <pre>
+ * <code>
+ * public static MetaDataKey&lt;Role&gt; ROLE = new MetaDataKey&lt;Role&gt;() 
{ };
+ * </code>
+ * </pre>
  * 
  * @author Jonathan Locke
  * 
  * @param <T>
- *            The object that is stored
+ *            The type of the object which is stored
+ * 
+ * @see Session#getMetaData(MetaDataKey)
+ * @see Component#getMetaData(MetaDataKey)
+ * @see Application#getMetaData(MetaDataKey)
  */
 public abstract class MetaDataKey<T> implements IClusterable
 {