lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rm...@apache.org
Subject svn commit: r1383036 - in /lucene/dev/branches/branch_4x: ./ solr/ solr/contrib/ solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/ solr/core/ solr/core/src/java/org/apache/solr/util/plugin/
Date Mon, 10 Sep 2012 18:48:59 GMT
Author: rmuir
Date: Mon Sep 10 18:48:59 2012
New Revision: 1383036

URL: http://svn.apache.org/viewvc?rev=1383036&view=rev
Log:
fix some bad javadocs html, make AbstractPluginLoader actually readable

Modified:
    lucene/dev/branches/branch_4x/   (props changed)
    lucene/dev/branches/branch_4x/solr/   (props changed)
    lucene/dev/branches/branch_4x/solr/contrib/   (props changed)
    lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
    lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
    lucene/dev/branches/branch_4x/solr/core/   (props changed)
    lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/util/plugin/AbstractPluginLoader.java

Modified: lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java?rev=1383036&r1=1383035&r2=1383036&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
(original)
+++ lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/Context.java
Mon Sep 10 18:48:59 2012
@@ -136,7 +136,7 @@ public abstract class Context {
    * get a value by name in the given scope (entity, document,global)
    *
    * @param name  the key
-   * @param scope the scope from which the value is to be retreived
+   * @param scope the scope from which the value is to be retrieved
    * @return the object stored in the given scope with the given key
    */
   public abstract Object getSessionAttribute(String name, String scope);
@@ -151,7 +151,7 @@ public abstract class Context {
 
   /**
    * The request parameters passed over HTTP for this command the values in the
-   * map are either String(for single valued parameters) or List<String> (for
+   * map are either String(for single valued parameters) or List&lt;String&gt; (for
    * multi-valued parameters)
    *
    * @return the request parameters passed in the URL to initiate this process
@@ -208,7 +208,7 @@ public abstract class Context {
   public abstract void deleteDocByQuery(String query);
 
   /**Use this directly to  resolve variable
-   * @param var the variable neme 
+   * @param var the variable name 
    * @return the resolved value
    */
   public abstract Object resolve(String var);

Modified: lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java?rev=1383036&r1=1383035&r2=1383036&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
(original)
+++ lucene/dev/branches/branch_4x/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/XPathRecordReader.java
Mon Sep 10 18:48:59 2012
@@ -105,7 +105,7 @@ public class XPathRecordReader {
    * @param name The name for this field in the emitted record
    * @param xpath The xpath expression for this field
    * @param multiValued If 'true' then the emitted record will have values in 
-   *                    a List<String>
+   *                    a List&lt;String&gt;
    */
   public synchronized XPathRecordReader addField(String name, String xpath, boolean multiValued)
{
     addField0(xpath, name, multiValued, false, 0);
@@ -120,8 +120,8 @@ public class XPathRecordReader {
    * @param name The name for this field in the emitted record
    * @param xpath The xpath expression for this field
    * @param multiValued If 'true' then the emitted record will have values in 
-   *                    a List<String>
-   * @param flags FLATTEN: Recursivly combine text from all child XML elements
+   *                    a List&lt;String&gt;
+   * @param flags FLATTEN: Recursively combine text from all child XML elements
    */
   public synchronized XPathRecordReader addField(String name, String xpath, boolean multiValued,
int flags) {
     addField0(xpath, name, multiValued, false, flags);
@@ -136,7 +136,7 @@ public class XPathRecordReader {
    * @param xpath The xpath expression for this field
    * @param name The name for this field in the emitted record
    * @param multiValued If 'true' then the emitted record will have values in 
-   *                    a List<String>
+   *                    a List&lt;String&gt;
    * @param isRecord Flags that this XPATH is from a forEach statement
    * @param flags The only supported flag is 'FLATTEN'
    */

Modified: lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/util/plugin/AbstractPluginLoader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/util/plugin/AbstractPluginLoader.java?rev=1383036&r1=1383035&r2=1383036&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/util/plugin/AbstractPluginLoader.java
(original)
+++ lucene/dev/branches/branch_4x/solr/core/src/java/org/apache/solr/util/plugin/AbstractPluginLoader.java
Mon Sep 10 18:48:59 2012
@@ -72,9 +72,12 @@ public abstract class AbstractPluginLoad
   
   /**
    * Create a plugin from an XML configuration.  Plugins are defined using:
-   *   <plugin name="name1" class="solr.ClassName">
+   * <pre class="prettyprint">
+   * {@code
+   * <plugin name="name1" class="solr.ClassName">
    *      ...
-   *   </plugin>
+   * </plugin>}
+   * </pre>
    * 
    * @param name - The registered name.  In the above example: "name1"
    * @param className - class name for requested plugin.  In the above example: "solr.ClassName"
@@ -101,16 +104,19 @@ public abstract class AbstractPluginLoad
   abstract protected void init( T plugin, Node node ) throws Exception;
 
   /**
+   * Initializes and registers each plugin in the list.
    * Given a NodeList from XML in the form:
-   * 
-   *  <plugins>
+   * <pre class="prettyprint">
+   * {@code
+   * <plugins>
    *    <plugin name="name1" class="solr.ClassName" >
    *      ...
    *    </plugin>
    *    <plugin name="name2" class="solr.ClassName" >
    *      ...
    *    </plugin>
-   *  </plugins>
+   * </plugins>}
+   * </pre>
    * 
    * This will initialize and register each plugin from the list.  A class will 
    * be generated for each class name and registered to the given name.
@@ -120,7 +126,10 @@ public abstract class AbstractPluginLoad
    * plugins at startup.
    * 
    * One (and only one) plugin may declare itself to be the 'default' plugin using:
-   *    <plugin name="name2" class="solr.ClassName" default="true">
+   * <pre class="prettyprint">
+   * {@code
+   *    <plugin name="name2" class="solr.ClassName" default="true">}
+   * </pre>
    * If a default element is defined, it will be returned from this function.
    * 
    */
@@ -190,9 +199,13 @@ public abstract class AbstractPluginLoad
   }
   
   /**
-   * Given a NodeList from XML in the form:
+   * Initializes and registers a single plugin.
    * 
-   * <plugin name="name1" class="solr.ClassName" > ... </plugin>
+   * Given a NodeList from XML in the form:
+   * <pre class="prettyprint">
+   * {@code
+   * <plugin name="name1" class="solr.ClassName" > ... </plugin>}
+   * </pre>
    * 
    * This will initialize and register a single plugin. A class will be
    * generated for the plugin and registered to the given name.



Mime
View raw message