incubator-joshua git commit: javadoc fixes

[mj...@apache.org]

Repository: incubator-joshua
Updated Branches:
  refs/heads/master dfc94aa5e -> 2cd401480


javadoc fixes


Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua/commit/2cd40148
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/2cd40148
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/2cd40148

Branch: refs/heads/master
Commit: 2cd401480967d112d9e7e75bf9a0678011ff37b5
Parents: dfc94aa
Author: Matt Post <po...@cs.jhu.edu>
Authored: Wed Oct 5 11:22:57 2016 -0400
Committer: Matt Post <po...@cs.jhu.edu>
Committed: Wed Oct 5 11:22:57 2016 -0400

----------------------------------------------------------------------
 .../java/org/apache/joshua/decoder/ff/FeatureFunction.java  | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/2cd40148/src/main/java/org/apache/joshua/decoder/ff/FeatureFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/decoder/ff/FeatureFunction.java b/src/main/java/org/apache/joshua/decoder/ff/FeatureFunction.java
index 340af0e..7e6e7a5 100644
--- a/src/main/java/org/apache/joshua/decoder/ff/FeatureFunction.java
+++ b/src/main/java/org/apache/joshua/decoder/ff/FeatureFunction.java
@@ -45,8 +45,7 @@ import org.apache.joshua.decoder.segment_file.Sentence;
  * feature function is to compute the features that are fired in different
  * circumstances and then return the inner product of those features with the
  * weight vector. Feature functions can also produce estimates of their future
- * cost (via {@link org.apache.joshua.decoder.ff.FeatureFunction#estimateCost(Rule, Sentence)}); 
- * these values are not used in computing the
+ * cost (via estimateCost(Rule, Sentence)}); these values are not used in computing the
  * score, but are only used for sorting rules during cube pruning. The
  * individual features produced by each template should have globally unique
  * names; a good convention is to prefix each feature with the name of the
@@ -249,11 +248,11 @@ public abstract class FeatureFunction {
    * sorting. Later, the real cost of this feature function is called via
    * compute();
    * 
-   * @param rule {@link org.apache.joshua.decoder.ff.tm.Rule} to be utilized within computation
-   * @param sentence {@link org.apache.joshua.lattice.Lattice} input
+   * @param rule the rule to compute an estimated cost on 
+   * @param sentence the current input sentence
    * @return the *weighted* cost of applying the feature.
    */
-  public abstract float estimateCost(Rule rule);
+  public abstract float estimateCost(Rule rule, Sentence sentence);
 
   /**
    * This feature is called to produce a *weighted estimate* of the future cost