You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by iv...@apache.org on 2009/09/06 06:44:33 UTC

svn commit: r811757 - in /wicket/trunk/wicket/src: main/java/org/apache/wicket/ main/java/org/apache/wicket/markup/html/link/ main/java/org/apache/wicket/request/target/coding/ main/java/org/apache/wicket/request/target/component/ main/java/org/apache/...

Author: ivaynberg
Date: Sun Sep  6 04:44:30 2009
New Revision: 811757

URL: http://svn.apache.org/viewvc?rev=811757&view=rev
Log:
WICKET-2449: Fix javadoc biggest mistakes - mainly @Deprecated tags
Issue: WICKET-2449

Modified:
    wicket/trunk/wicket/src/main/java/org/apache/wicket/IPageFactory.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/Localizer.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/MetaDataKey.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/Page.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/PageId.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/markup/html/link/PageLink.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/HybridUrlCodingStrategy.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/component/PageIdRequestTarget.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/ConverterLocator.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/MaskConverter.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java
    wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java
    wicket/trunk/wicket/src/test/java/org/apache/wicket/request/target/coding/IndexedSharedResourceCodingStrategyTest.java
    wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/LoginPage.java
    wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/UsernamePasswordSignInPanel.java

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/IPageFactory.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/IPageFactory.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/IPageFactory.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/IPageFactory.java Sun Sep  6 04:44:30 2009
@@ -27,7 +27,6 @@
  * 
  * @see org.apache.wicket.settings.ISessionSettings#setPageFactory(IPageFactory)
  * @see Session#getPageFactory()
- * @see Session#getPageFactory(Page)
  * 
  * @author Juergen Donnerstag
  * @author Jonathan Locke

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/Localizer.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/Localizer.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/Localizer.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/Localizer.java Sun Sep  6 04:44:30 2009
@@ -150,8 +150,9 @@
 	 * @return String
 	 * @throws MissingResourceException
 	 * 
-	 * @Deprecated please use {@link #getString(String, Component, IModel, String)}
+	 * @deprecated please use {@link #getString(String, Component, IModel, String)}
 	 */
+	@Deprecated
 	public String getString(final String key, final Component component, final IModel<?> model,
 		final Locale locale, final String style, final String defaultValue)
 		throws MissingResourceException

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/MetaDataKey.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/MetaDataKey.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/MetaDataKey.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/MetaDataKey.java Sun Sep  6 04:44:30 2009
@@ -36,9 +36,6 @@
 
 	/**
 	 * Constructor.
-	 * 
-	 * @param type
-	 *            The type of value stored under this key
 	 */
 	public MetaDataKey()
 	{

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/Page.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/Page.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/Page.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/Page.java Sun Sep  6 04:44:30 2009
@@ -688,7 +688,7 @@
 			try
 			{
 
-				if (getClass().getConstructor(new Class[] { }) != null)
+				if (getClass().getConstructor(new Class[] {}) != null)
 				{
 					bookmarkable = Boolean.TRUE;
 				}
@@ -1670,7 +1670,7 @@
 	 * 
 	 * @return instance unique identifier
 	 * 
-	 * @depricated This method will be removed before the final of 1.4
+	 * @deprecated This method will be removed before the final of 1.4
 	 */
 	@Deprecated
 	public PageId getPageId()

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/PageId.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/PageId.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/PageId.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/PageId.java Sun Sep  6 04:44:30 2009
@@ -22,7 +22,7 @@
  * 
  * @author igor.vaynberg
  * 
- * @depricated will be removed
+ * @deprecated will be removed
  */
 @Deprecated
 public final class PageId extends PageReference

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/markup/html/link/PageLink.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/markup/html/link/PageLink.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/markup/html/link/PageLink.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/markup/html/link/PageLink.java Sun Sep  6 04:44:30 2009
@@ -32,7 +32,7 @@
  * @param <T>
  *            type of model object
  * 
- * @deprecated use BookmarkabpePageLink or Link instead
+ * @deprecated use {@link BookmarkablePageLink} or {@link Link} instead
  * 
  */
 @Deprecated

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/HybridUrlCodingStrategy.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/HybridUrlCodingStrategy.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/HybridUrlCodingStrategy.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/coding/HybridUrlCodingStrategy.java Sun Sep  6 04:44:30 2009
@@ -539,7 +539,8 @@
 	}
 
 	/**
-	 * @see org.apache.wicket.request.target.coding.AbstractRequestTargetUrlCodingStrategy#matches(java.lang.String)
+	 * @see org.apache.wicket.request.target.coding.AbstractRequestTargetUrlCodingStrategy#matches(String,
+	 *      boolean)
 	 */
 	@Override
 	public boolean matches(final String path, final boolean caseSensitive)

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/component/PageIdRequestTarget.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/component/PageIdRequestTarget.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/component/PageIdRequestTarget.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/request/target/component/PageIdRequestTarget.java Sun Sep  6 04:44:30 2009
@@ -27,7 +27,7 @@
  * @see PageReference
  * 
  * @author igor.vaynberg
- * @depricated will be removed before 1.5
+ * @deprecated will be removed before 1.5
  */
 @Deprecated
 public class PageIdRequestTarget extends PageReferenceRequestTarget

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/ConverterLocator.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/ConverterLocator.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/ConverterLocator.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/ConverterLocator.java Sun Sep  6 04:44:30 2009
@@ -54,9 +54,6 @@
 {
 	/**
 	 * CoverterLocator that is to be used when no registered converter is found.
-	 * 
-	 * @param <X>
-	 *            The converter object type
 	 */
 	private class DefaultConverter implements IConverter
 	{
@@ -175,15 +172,11 @@
 	/**
 	 * Gets the type converter that is registered for class c.
 	 * 
-	 * @param <T>
-	 *            converter type
-	 * 
 	 * @param c
 	 *            The class to get the type converter for
 	 * @return The type converter that is registered for class c or null if no type converter was
 	 *         registered for class c
 	 */
-	@SuppressWarnings("unchecked")
 	public final IConverter get(Class<?> c)
 	{
 		return classToConverter.get(c.getName());
@@ -199,7 +192,6 @@
 	 * 
 	 * @see org.apache.wicket.util.convert.IConverter#convertToObject(String, java.util.Locale)
 	 */
-	@SuppressWarnings("unchecked")
 	public final IConverter getConverter(Class<?> type)
 	{
 		// Null is always converted to null
@@ -221,14 +213,11 @@
 	/**
 	 * Removes the type converter currently registered for class c.
 	 * 
-	 * @param The
-	 *            type of the converter
 	 * @param c
 	 *            The class for which the converter registration should be removed
 	 * @return The converter that was registered for class c before removal or null if none was
 	 *         registered
 	 */
-	@SuppressWarnings("unchecked")
 	public final IConverter remove(Class<?> c)
 	{
 		return classToConverter.remove(c.getName());
@@ -237,9 +226,6 @@
 	/**
 	 * Registers a converter for use with class c.
 	 * 
-	 * @param The
-	 *            type of the converter
-	 * 
 	 * @param converter
 	 *            The converter to add
 	 * @param c

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/MaskConverter.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/MaskConverter.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/MaskConverter.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/convert/MaskConverter.java Sun Sep  6 04:44:30 2009
@@ -81,8 +81,6 @@
  * mask is on a per character basis, and will thus adjust to fit as many chars as are needed.
  * </p>
  * 
- * @param <T>
- *            The converter object type
  * @see MaskFormatter
  * 
  * @author Eelco Hillenius
@@ -151,7 +149,6 @@
 	 * 
 	 * @see org.apache.wicket.util.convert.IConverter#convertToObject(java.lang.String, Locale)
 	 */
-	@SuppressWarnings("unchecked")
 	public Object convertToObject(String value, Locale locale)
 	{
 		try

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/CopyOnWriteValueMap.java Sun Sep  6 04:44:30 2009
@@ -426,7 +426,7 @@
 	}
 
 	/**
-	 * @see IValueMap#getAsEnum(String, Class<T>)
+	 * @see IValueMap#getAsEnum(String, Class)
 	 */
 	public <T extends Enum<T>> T getAsEnum(String key, Class<T> eClass)
 	{
@@ -442,7 +442,7 @@
 	}
 
 	/**
-	 * @see IValueMap#getAsEnum(String, Class<T>, T)
+	 * @see IValueMap#getAsEnum(String, Class, Enum)
 	 */
 	public <T extends Enum<T>> T getAsEnum(String key, Class<T> eClass, T defaultValue)
 	{

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/IntValue.java Sun Sep  6 04:44:30 2009
@@ -48,7 +48,7 @@
 	}
 
 	/**
-	 * @param object
+	 * @param that
 	 *            The object to compare with
 	 * @return 0 if equal, -1 if less than or 1 if greater than
 	 */
@@ -70,7 +70,7 @@
 	/**
 	 * Compares this <code>Object</code> to a given <code>Object</code>.
 	 * 
-	 * @param object
+	 * @param that
 	 *            the <code>Object</code> to compare with
 	 * @return 0 if equal, -1 if less than the given <code>Object</code>'s value, or 1 if greater
 	 *         than given <code>Object</code>'s value

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/LongValue.java Sun Sep  6 04:44:30 2009
@@ -50,7 +50,7 @@
 	/**
 	 * Compares this <code>Object</code> to a given <code>Object</code>.
 	 * 
-	 * @param object
+	 * @param that
 	 *            the <code>Object</code> to compare with
 	 * @return 0 if equal, -1 if less than the given <code>Object</code>'s value, or 1 if greater
 	 *         than given <code>Object</code>'s value

Modified: wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java (original)
+++ wicket/trunk/wicket/src/main/java/org/apache/wicket/util/value/ValueMap.java Sun Sep  6 04:44:30 2009
@@ -434,7 +434,7 @@
 	}
 
 	/**
-	 * @see java.util.Map#put(java.lang.String, java.lang.Object)
+	 * @see java.util.Map#put(Object, Object)
 	 */
 	@Override
 	public Object put(final String key, final Object value)

Modified: wicket/trunk/wicket/src/test/java/org/apache/wicket/request/target/coding/IndexedSharedResourceCodingStrategyTest.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/test/java/org/apache/wicket/request/target/coding/IndexedSharedResourceCodingStrategyTest.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/test/java/org/apache/wicket/request/target/coding/IndexedSharedResourceCodingStrategyTest.java (original)
+++ wicket/trunk/wicket/src/test/java/org/apache/wicket/request/target/coding/IndexedSharedResourceCodingStrategyTest.java Sun Sep  6 04:44:30 2009
@@ -27,10 +27,7 @@
 import org.apache.wicket.util.resource.IResourceStream;
 import org.apache.wicket.util.value.ValueMap;
 
-/**
- * 
- * @author
- */
+/** */
 public class IndexedSharedResourceCodingStrategyTest extends WicketTestCase
 {
 	private static final String URL_PREFIX = "/WicketTester$DummyWebApplication/WicketTester$DummyWebApplication/";
@@ -39,7 +36,6 @@
 	private TestResource resource;
 
 	/**
-	 * 
 	 * @see org.apache.wicket.WicketTestCase#setUp()
 	 */
 	@Override

Modified: wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/LoginPage.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/LoginPage.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/LoginPage.java (original)
+++ wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/LoginPage.java Sun Sep  6 04:44:30 2009
@@ -39,8 +39,8 @@
 	}
 
 	/**
-	 * Creeert een sign in panel voor instellingen die hun authenticatie enkel baseren op
-	 * username/wachtwoord.
+	 * Creates a sign in panel on institutions that rely solely on their authentication username /
+	 * password.
 	 * 
 	 * @param panelId
 	 * @param info

Modified: wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/UsernamePasswordSignInPanel.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/UsernamePasswordSignInPanel.java?rev=811757&r1=811756&r2=811757&view=diff
==============================================================================
--- wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/UsernamePasswordSignInPanel.java (original)
+++ wicket/trunk/wicket/src/test/java/org/apache/wicket/stateless/pages/UsernamePasswordSignInPanel.java Sun Sep  6 04:44:30 2009
@@ -37,8 +37,6 @@
 /**
  * 
  * @author marrink
- * @param <T>
- *            The model object type
  */
 public class UsernamePasswordSignInPanel extends Panel
 {
@@ -78,10 +76,10 @@
 	 */
 	public static final class SignInForm extends StatelessForm<IValueMap>
 	{
-		/** Voor serializatie. */
+		/** For serialisation. */
 		private static final long serialVersionUID = 1L;
 
-		/** Moeten de inlog waarden bewaard blijven? */
+		/** Should the login values preserved? */
 		private boolean rememberMe = true;
 
 		private final UsernamePasswordSignInPanel panel;
@@ -143,7 +141,7 @@
 		}
 
 		/**
-		 * Geeft terug of de waarden van het formulier bewaard moeten worden of niet.
+		 * Returns whether the values of the form should be kept or not.
 		 * 
 		 * @return
 		 */
@@ -153,7 +151,7 @@
 		}
 
 		/**
-		 * Zet of de waarden van het formulier bewaard moeten worden of niet.
+		 * Set whether the values of the form should be kept or not.
 		 * 
 		 * @param rememberMe
 		 */