SOLR-489 - ading some @deprecation javadoc details

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@631124 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/solr/common/SolrException.java

@@ -74,12 +74,18 @@ public class SolrException extends RuntimeException {
     logged=true;
   }
   
+  /**
+   * @deprecated Use {@link #SolrException(ErrorCode,String)}.
+   */
   @Deprecated
   public SolrException(int code, String msg) {
     super(msg);
     this.code=code;
   }
   
+  /**
+   * @deprecated Use {@link #SolrException(ErrorCode,String,boolean)}.
+   */
   @Deprecated
   public SolrException(int code, String msg, boolean alreadyLogged) {
     super(msg);
@@ -87,6 +93,9 @@ public class SolrException extends RuntimeException {
     this.logged=alreadyLogged;
   }
 
+  /**
+   * @deprecated Use {@link #SolrException(ErrorCode,String,Throwable,boolean)}.
+   */
   @Deprecated
   public SolrException(int code, String msg, Throwable th, boolean alreadyLogged) {
     super(msg,th);
@@ -94,11 +103,17 @@ public class SolrException extends RuntimeException {
     logged=alreadyLogged;
   }
 
+  /**
+   * @deprecated Use {@link #SolrException(ErrorCode,String,Throwable)}.
+   */
   @Deprecated
   public SolrException(int code, String msg, Throwable th) {
     this(code,msg,th,true);
   }
 
+  /**
+   * @deprecated Use {@link #SolrException(ErrorCode,Throwable)}.
+   */
   @Deprecated
   public SolrException(int code, Throwable th) {
     super(th);

src/java/org/apache/solr/core/SolrException.java

@@ -19,6 +19,8 @@ package org.apache.solr.core;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.SolrException
  */
 @Deprecated
 public class SolrException extends org.apache.solr.common.SolrException {

src/java/org/apache/solr/core/SolrInfoRegistry.java

@@ -23,6 +23,8 @@ import java.util.*;
 
 /**
  * @version $Id$
+ *
+ * @deprecated Solr now supports multiple cores and no longer uses a static singleton for SolrCore. 
  */
 
 // A Registry to hold a collection of SolrInfo objects

src/java/org/apache/solr/handler/RequestHandlerUtils.java

@@ -48,8 +48,8 @@ public class RequestHandlerUtils
    * Check the request parameters and decide if it should commit or optimize.
    * If it does, it will check parameters for "waitFlush" and "waitSearcher"
    * 
-   * Use the update processor version
-   * 
+   * @deprecated Use {@link #handleCommit(UpdateRequestProcessor,SolrParams,boolean)}
+   *
    * @since solr 1.2
    */
   @Deprecated

src/java/org/apache/solr/request/AppendedSolrParams.java

@@ -21,6 +21,8 @@ import org.apache.solr.common.params.SolrParams;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.AppendedSolrParams
  */
 @Deprecated
 public class AppendedSolrParams extends org.apache.solr.common.params.AppendedSolrParams {

src/java/org/apache/solr/request/DefaultSolrParams.java

@@ -21,6 +21,8 @@ import org.apache.solr.common.params.SolrParams;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.DefaultSolrParams.
  */
 @Deprecated
 public class DefaultSolrParams extends org.apache.solr.common.params.DefaultSolrParams {

src/java/org/apache/solr/request/MapSolrParams.java

@@ -21,6 +21,8 @@ import java.util.Map;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.MapSolrParams
  */
 @Deprecated
 public class MapSolrParams extends org.apache.solr.common.params.MapSolrParams {

src/java/org/apache/solr/request/MultiMapSolrParams.java

@@ -21,6 +21,8 @@ import java.util.Map;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.MultiMapSolrParams.
  */
 @Deprecated
 public class MultiMapSolrParams extends org.apache.solr.common.params.MultiMapSolrParams {

src/java/org/apache/solr/request/RequiredSolrParams.java

@@ -21,6 +21,8 @@ import org.apache.solr.common.params.SolrParams;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.RequiredSolrParams.
  */
 @Deprecated
 public class RequiredSolrParams extends org.apache.solr.common.params.RequiredSolrParams {

src/java/org/apache/solr/request/SolrParams.java

@@ -23,6 +23,8 @@ import org.apache.solr.common.params.FacetParams;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.SolrParams.
  */
 @Deprecated
 public abstract class SolrParams extends org.apache.solr.common.params.SolrParams

src/java/org/apache/solr/request/SolrQueryRequestBase.java

@@ -43,14 +43,29 @@ import java.util.HashMap;
  * @version $Id$
  */
 public abstract class SolrQueryRequestBase implements SolrQueryRequest {
+  /**
+   * @deprecated Use org.apache.solr.common.params.CommonParams
+   */
   @Deprecated
   public static final String QUERY_NAME="q";
+  /**
+   * @deprecated Use org.apache.solr.common.params.CommonParams
+   */
   @Deprecated
   public static final String START_NAME="start";
+  /**
+   * @deprecated Use org.apache.solr.common.params.CommonParams
+   */
   @Deprecated
   public static final String ROWS_NAME="rows";
+  /**
+   * @deprecated Use org.apache.solr.common.params.CommonParams
+   */
   @Deprecated
   public static final String XSL_NAME="xsl";
+  /**
+   * @deprecated Use org.apache.solr.common.params.CommonParams
+   */
   @Deprecated
   public static final String QUERYTYPE_NAME="qt";
 

src/java/org/apache/solr/util/ContentStream.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.ContentStream.
  */
 @Deprecated
 public interface ContentStream extends org.apache.solr.common.util.ContentStream {

src/java/org/apache/solr/util/ContentStreamBase.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.ContentStreamBase
  */
 @Deprecated
 public abstract class ContentStreamBase extends org.apache.solr.common.util.ContentStreamBase

src/java/org/apache/solr/util/DOMUtil.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.DOMUtil.
  */
 @Deprecated
 public class DOMUtil extends org.apache.solr.common.util.DOMUtil {

src/java/org/apache/solr/util/IteratorChain.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.IteratorChain<E>.
  */
 @Deprecated
 public class IteratorChain<E> extends org.apache.solr.common.util.IteratorChain<E> {

src/java/org/apache/solr/util/NamedList.java

@@ -21,6 +21,8 @@ import java.util.List;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.NamedList<T>.
  */
 @Deprecated
 public class NamedList<T> extends org.apache.solr.common.util.NamedList<T> {

src/java/org/apache/solr/util/SimpleOrderedMap.java

@@ -20,6 +20,8 @@ import java.util.List;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.SimpleOrderedMap<T>.
  */
 @Deprecated
 public class SimpleOrderedMap<T> extends org.apache.solr.common.util.SimpleOrderedMap<T> {

src/java/org/apache/solr/util/SolrPluginUtils.java

@@ -95,7 +95,11 @@ public class SolrPluginUtils {
   }
 
 
-  /** standard param for field list */
+  /**
+   * standard param for field list
+   *
+   * @deprecated Use org.apache.solr.common.params.CommonParams.FL.
+   */
   @Deprecated
   public static String FL = org.apache.solr.common.params.CommonParams.FL;
 

src/java/org/apache/solr/util/StrUtils.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.StrUtils.
  */
 @Deprecated
 public class StrUtils extends org.apache.solr.common.util.StrUtils

src/java/org/apache/solr/util/TestHarness.java

@@ -142,7 +142,7 @@ public class TestHarness {
    * Processes an "update" (add, commit or optimize) and
    * returns the response as a String.
    * 
-   * The better approach is to instanciate a Updatehandler directly
+   * @deprecated The better approach is to instantiate an Updatehandler directly
    *
    * @param xml The XML of the update
    * @return The XML response to the update

src/java/org/apache/solr/util/UpdateParams.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.params.UpdateParams.
  */
 @Deprecated
 public interface UpdateParams extends org.apache.solr.common.params.UpdateParams

src/java/org/apache/solr/util/XML.java

@@ -19,6 +19,8 @@ package org.apache.solr.util;
 
 /**
  * This class is scheduled for deletion.  Please update your code to the moved package.
+ *
+ * @deprecated Use org.apache.solr.common.util.XML.
  */
 @Deprecated
 public class XML extends org.apache.solr.common.util.XML {

src/webapp/src/org/apache/solr/servlet/SolrUpdateServlet.java

@@ -31,6 +31,8 @@ import org.apache.solr.request.XMLResponseWriter;
 
 /**
  * @version $Id$
+ *
+ * @deprecated Register a request handler to /update rather then use this servlet.  Add: <requestHandler name="/update" class="solr.XmlUpdateRequestHandler" > to your solrconfig.xml
  */
 @Deprecated
 public class SolrUpdateServlet extends HttpServlet {