fix a lot of trivial javadoc warnings

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@677767 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Chris M. Hostetter 2008-07-17 22:44:30 +00:00
parent a00dec824d
commit d86a9b8a20
10 changed files with 13 additions and 14 deletions

View File

@ -27,7 +27,7 @@ import java.util.*;
* started automatically when created. * started automatically when created.
* *
* @since solr 1.3 * @since solr 1.3
* @revision $Id$ * @version $Id$
*/ */
public class RTimer { public class RTimer {

View File

@ -18,6 +18,7 @@
package org.apache.solr.core; package org.apache.solr.core;
import org.apache.solr.common.util.NamedList; import org.apache.solr.common.util.NamedList;
import org.apache.solr.handler.PingRequestHandler;
import org.apache.solr.request.LocalSolrQueryRequest; import org.apache.solr.request.LocalSolrQueryRequest;
import org.apache.solr.request.SolrQueryRequest; import org.apache.solr.request.SolrQueryRequest;
@ -189,7 +190,7 @@ public class SolrConfig extends Config {
* Returns a Request object based on the admin/pingQuery section * Returns a Request object based on the admin/pingQuery section
* of the Solr config file. * of the Solr config file.
* *
* @use {@link PingRequestHandler} instead * @deprecated use {@link PingRequestHandler} instead
*/ */
@Deprecated @Deprecated
public SolrQueryRequest getPingQueryRequest(SolrCore core) { public SolrQueryRequest getPingQueryRequest(SolrCore core) {

View File

@ -541,7 +541,7 @@ public final class SolrCore {
* Returns a Request object based on the admin/pingQuery section * Returns a Request object based on the admin/pingQuery section
* of the Solr config file. * of the Solr config file.
* *
* @use {@link org.apache.solr.handler.PingRequestHandler} instead * @deprecated use {@link org.apache.solr.handler.PingRequestHandler} instead
*/ */
@Deprecated @Deprecated
public SolrQueryRequest getPingQueryRequest() { public SolrQueryRequest getPingQueryRequest() {

View File

@ -53,8 +53,10 @@ public abstract class SearchComponent implements SolrInfoMBean, NamedListInitial
*/ */
public abstract void process(ResponseBuilder rb) throws IOException; public abstract void process(ResponseBuilder rb) throws IOException;
/** Process for a distributed search. /**
* @returns the next stage for this component */ * Process for a distributed search.
* @return the next stage for this component
*/
public int distributedProcess(ResponseBuilder rb) throws IOException { public int distributedProcess(ResponseBuilder rb) throws IOException {
return ResponseBuilder.STAGE_DONE; return ResponseBuilder.STAGE_DONE;
} }

View File

@ -67,7 +67,6 @@ public class FunctionQParser extends QParser {
/** /**
* TODO: Doc * TODO: Doc
* *
* @return
* @throws ParseException * @throws ParseException
*/ */
public String parseId() throws ParseException { public String parseId() throws ParseException {
@ -107,7 +106,6 @@ public class FunctionQParser extends QParser {
/** /**
* Parse an individual ValueSource. * Parse an individual ValueSource.
* *
* @return
* @throws ParseException * @throws ParseException
*/ */
public ValueSource parseValueSource() throws ParseException { public ValueSource parseValueSource() throws ParseException {
@ -118,7 +116,6 @@ public class FunctionQParser extends QParser {
/** /**
* TODO: Doc * TODO: Doc
* *
* @return
* @throws ParseException * @throws ParseException
*/ */
public Query parseNestedQuery() throws ParseException { public Query parseNestedQuery() throws ParseException {
@ -170,7 +167,6 @@ public class FunctionQParser extends QParser {
* Parse an individual value source. * Parse an individual value source.
* *
* @param doConsumeDelimiter whether to consume a delimiter following the ValueSource * @param doConsumeDelimiter whether to consume a delimiter following the ValueSource
* @return
* @throws ParseException * @throws ParseException
*/ */
protected ValueSource parseValueSource(boolean doConsumeDelimiter) throws ParseException { protected ValueSource parseValueSource(boolean doConsumeDelimiter) throws ParseException {

View File

@ -77,9 +77,10 @@ public abstract class QParser {
this.qstr = s; this.qstr = s;
} }
/** Returns the resulting query from this QParser, calling parse() only the /**
* Returns the resulting query from this QParser, calling parse() only the
* first time and caching the Query result. * first time and caching the Query result.
* @return *
* @throws ParseException * @throws ParseException
*/ */
public Query getQuery() throws ParseException { public Query getQuery() throws ParseException {

View File

@ -57,7 +57,6 @@ public abstract class ValueSourceParser implements NamedListInitializedPlugin
* Parse the user input into a ValueSource. * Parse the user input into a ValueSource.
* *
* @param fp * @param fp
* @return
* @throws ParseException * @throws ParseException
*/ */
public abstract ValueSource parse(FunctionQParser fp) throws ParseException; public abstract ValueSource parse(FunctionQParser fp) throws ParseException;

View File

@ -109,7 +109,6 @@ public abstract class SolrSpellChecker {
* @param count The maximum number of suggestions to return * @param count The maximum number of suggestions to return
* @param onlyMorePopular TODO * @param onlyMorePopular TODO
* @param extendedResults TODO * @param extendedResults TODO
* @return
* @throws IOException * @throws IOException
*/ */
public abstract SpellingResult getSuggestions(Collection<Token> tokens, IndexReader reader, int count, public abstract SpellingResult getSuggestions(Collection<Token> tokens, IndexReader reader, int count,

View File

@ -27,7 +27,7 @@ public class CommitUpdateCommand extends UpdateCommand {
/** /**
* During optimize, optimize down to <= this many segments. Must be >= 1 * During optimize, optimize down to <= this many segments. Must be >= 1
* *
* @see {@link org.apache.lucene.index.IndexWriter#optimize(int)} * @see org.apache.lucene.index.IndexWriter#optimize(int)
*/ */
public int maxOptimizeSegments = 1; public int maxOptimizeSegments = 1;

View File

@ -36,6 +36,7 @@ import org.apache.solr.schema.SchemaField;
import org.apache.solr.schema.FieldType; import org.apache.solr.schema.FieldType;
import org.apache.solr.common.SolrException; import org.apache.solr.common.SolrException;
import org.apache.solr.common.util.DOMUtil; import org.apache.solr.common.util.DOMUtil;
import org.apache.solr.util.plugin.SolrCoreAware;
import org.apache.solr.core.*; import org.apache.solr.core.*;
import javax.xml.xpath.XPathConstants; import javax.xml.xpath.XPathConstants;