javadoc warning cleanup

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@578977 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Chris M. Hostetter 2007-09-24 21:20:53 +00:00
parent bb036b1df9
commit 1ccfec05f1
7 changed files with 13 additions and 16 deletions

View File

@ -57,7 +57,7 @@ public class SolrInputDocument implements Iterable<SolrInputField>
/**
* Add a field with implied null value for boost.
*
* @see addField(String, Object, Float)
* @see #addField(String, Object, float)
* @param name name of the field to add
* @param value value of the field
*/
@ -104,7 +104,7 @@ public class SolrInputDocument implements Iterable<SolrInputField>
/** Set a field with implied null value for boost.
*
* @see setField(String, Object, Float)
* @see #setField(String, Object, float)
* @param name name of the field to set
* @param value value of the field
*/
@ -137,7 +137,7 @@ public class SolrInputDocument implements Iterable<SolrInputField>
/**
* Remove a field from the document
*
* @param key The field name whose field is to be removed from the document
* @param name The field name whose field is to be removed from the document
* @return the previous field with <tt>name</tt>, or
* <tt>null</tt> if there was no field for <tt>key</tt>.
*/

View File

@ -36,7 +36,7 @@ public interface SolrFormatter extends SolrInfoMBean, NamedListInitializedPlugin
* Return a formatter appropriate for this field.
*
* @param fieldName The name of the field
* @param request The current SolrQueryRequest
* @param params The params controlling Highlighting
* @return An appropriate Formatter.
*/
public Formatter getFormatter(String fieldName, SolrParams params );

View File

@ -36,7 +36,7 @@ public interface SolrFragmenter extends SolrInfoMBean, NamedListInitializedPlugi
* Return a fragmenter appropriate for this field.
*
* @param fieldName The name of the field
* @param request The current SolrQueryRequest
* @param params The params controlling Highlighting
* @return An appropriate Fragmenter.
*/
public Fragmenter getFragmenter(String fieldName, SolrParams params);

View File

@ -103,7 +103,7 @@ public class SolrHighlighter
/**
* Check whether Highlighting is enabled for this request.
* @param request The current SolrQueryRequest
* @param params The params controlling Highlighting
* @return <code>true</code> if highlighting enabled, <code>false</code> if not.
*/
public boolean isHighlightingEnabled(SolrParams params) {
@ -182,7 +182,7 @@ public class SolrHighlighter
* been configured for this field, fall back to the configured default
* or the solr default.
* @param fieldName The name of the field
* @param request The current SolrQueryRequest
* @param params The params controlling Highlighting
*/
protected int getMaxSnippets(String fieldName, SolrParams params) {
return params.getFieldInt(fieldName, HighlightParams.SNIPPETS,1);
@ -194,7 +194,7 @@ public class SolrHighlighter
* default or the solr default (SimpleHTMLFormatter).
*
* @param fieldName The name of the field
* @param request The current SolrQueryRequest
* @param params The params controlling Highlighting
* @return An appropriate Formatter.
*/
protected Formatter getFormatter(String fieldName, SolrParams params )
@ -213,7 +213,7 @@ public class SolrHighlighter
* default or the solr default (GapFragmenter).
*
* @param fieldName The name of the field
* @param request The current SolrQueryRequest
* @param params The params controlling Highlighting
* @return An appropriate Fragmenter.
*/
protected Fragmenter getFragmenter(String fieldName, SolrParams params)

View File

@ -813,7 +813,7 @@ public class SolrPluginUtils {
/**
* Builds a list of Query objects that should be used to filter results
* @see SolrParams#FQ
* @see CommonParams#FQ
* @return null if no filter queries
*/
public static List<Query> parseFilterQueries(SolrQueryRequest req) throws ParseException {

View File

@ -98,16 +98,14 @@ public class TestHarness {
this( dataDirectory, "solrconfig.xml", schemaFile);
}
/**
* @param name the core name
* @param dataDirectory path for index data, will not be cleaned up
* @param configFile solrconfig filename
* @param configFile solrconfig filename
* @param schemaFile schema filename
*/
public TestHarness( String dataDirectory, String configFile, String schemaFile) {
this( dataDirectory, createConfig(configFile), schemaFile);
}
/**
* @param name the core name
* @param dataDirectory path for index data, will not be cleaned up
* @param solrConfig solronfig instance
* @param schemaFile schema filename
@ -118,10 +116,9 @@ public class TestHarness {
this( dataDirectory, solrConfig, new IndexSchema(solrConfig, schemaFile));
}
/**
* @param name the core name
* @param dataDirectory path for index data, will not be cleaned up
* @param solrConfig solrconfig instance
* @param schema schema instance
* @param indexSchema schema instance
*/
public TestHarness( String dataDirectory,
SolrConfig solrConfig,

View File

@ -45,7 +45,7 @@ public abstract class AbstractPluginLoader<T>
/**
* @param type is the 'type' name included in error messages.
* @param preRegister, if true, this will first register all Plugins, then it will initialize them.
* @param preRegister if true, this will first register all Plugins, then it will initialize them.
*/
public AbstractPluginLoader( String type, boolean preRegister, boolean requireName )
{