svn commit: r651021 - /lucene/mahout/trunk/core/src/main/java/org/apache/mahout/utils/parameters/Parameter.java

[ka...@apache.org]

Author: kalle
Date: Wed Apr 23 12:26:42 2008
New Revision: 651021

URL: http://svn.apache.org/viewvc?rev=651021&view=rev
Log:
MAHOUT-49, interface Paramered. A pattern for recursively configuring composite JobConfigurables, produce configuration files, getter/setter access, good looking help, and all that.

Minor javadocs update

Modified:
    lucene/mahout/trunk/core/src/main/java/org/apache/mahout/utils/parameters/Parameter.java

Modified: lucene/mahout/trunk/core/src/main/java/org/apache/mahout/utils/parameters/Parameter.java
URL: http://svn.apache.org/viewvc/lucene/mahout/trunk/core/src/main/java/org/apache/mahout/utils/parameters/Parameter.java?rev=651021&r1=651020&r2=651021&view=diff
==============================================================================
--- lucene/mahout/trunk/core/src/main/java/org/apache/mahout/utils/parameters/Parameter.java (original)
+++ lucene/mahout/trunk/core/src/main/java/org/apache/mahout/utils/parameters/Parameter.java Wed Apr 23 12:26:42 2008
@@ -26,9 +26,9 @@
  * in that DistanceMeasure implementation.
  */
 public interface Parameter<T> extends Parametered {
-  /** @return job configuration setting key prefix */
+  /** @return job configuration setting key prefix, e.g. 'org.apache.mahout.util.WeightedDistanceMeasure.' */
   public abstract String prefix();
-  /** @return configuration parameters name, e.g. org.apache.mahout.util.WeightedDistanceMeasure.weightsFile */
+  /** @return configuration parameters name, e.g. 'weightsFile' */
   public abstract String name();
   /** @return human readable description of parameters */
   public abstract String description();