You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@joshua.apache.org by mj...@apache.org on 2016/06/22 03:37:28 UTC

incubator-joshua git commit: javadoc fixes

Repository: incubator-joshua
Updated Branches:
  refs/heads/master c01ce779c -> a06a01550


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/a06a0155
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/a06a0155
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/a06a0155

Branch: refs/heads/master
Commit: a06a015505c6e18112657535075075ca82e69b68
Parents: c01ce77
Author: Matt Post <po...@cs.jhu.edu>
Authored: Tue Jun 21 23:37:25 2016 -0400
Committer: Matt Post <po...@cs.jhu.edu>
Committed: Tue Jun 21 23:37:25 2016 -0400

----------------------------------------------------------------------
 .../java/org/apache/joshua/decoder/StructuredTranslation.java   | 5 +++--
 src/main/java/org/apache/joshua/decoder/io/JSONMessage.java     | 2 +-
 src/main/java/org/apache/joshua/metrics/CHRF.java               | 2 +-
 3 files changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/a06a0155/src/main/java/org/apache/joshua/decoder/StructuredTranslation.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/decoder/StructuredTranslation.java b/src/main/java/org/apache/joshua/decoder/StructuredTranslation.java
index fb97ee7..b44a7f0 100644
--- a/src/main/java/org/apache/joshua/decoder/StructuredTranslation.java
+++ b/src/main/java/org/apache/joshua/decoder/StructuredTranslation.java
@@ -83,9 +83,9 @@ public class StructuredTranslation {
   }
   
   /**
-   * Returns the output string formatted according to {@value JoshuaConfiguration.output_format}.
+   * Returns the output string formatted according to JoshuaConfiguration.output_format.
    * 
-   * @return
+   * @return the formatted string
    */
   public String getFormattedTranslationString() {
     throw new RuntimeException("Not yet implemented");
@@ -101,6 +101,7 @@ public class StructuredTranslation {
 
   /**
    * Returns a list of target to source alignments.
+   * 
    * @return a list of target to source alignments
    */
   public List<List<Integer>> getTranslationWordAlignments() {

http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/a06a0155/src/main/java/org/apache/joshua/decoder/io/JSONMessage.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/decoder/io/JSONMessage.java b/src/main/java/org/apache/joshua/decoder/io/JSONMessage.java
index 6ec3e57..90a550b 100644
--- a/src/main/java/org/apache/joshua/decoder/io/JSONMessage.java
+++ b/src/main/java/org/apache/joshua/decoder/io/JSONMessage.java
@@ -102,7 +102,7 @@ public class JSONMessage {
    * Adds a new Translation to the JSON object. A Translation represents one or more hypotheses
    * (or k-best items)
    * 
-   * @param text
+   * @param text the translation text
    * @return the new TranslationItem object
    */
   public TranslationItem addTranslation(String text) {

http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/a06a0155/src/main/java/org/apache/joshua/metrics/CHRF.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/metrics/CHRF.java b/src/main/java/org/apache/joshua/metrics/CHRF.java
index f02fc5f..d67f6e0 100644
--- a/src/main/java/org/apache/joshua/metrics/CHRF.java
+++ b/src/main/java/org/apache/joshua/metrics/CHRF.java
@@ -25,7 +25,7 @@ import java.util.logging.Logger;
  * An implementation of the chrF evaluation metric for tuning.
  * It is based on the original code by Maja Popovic [1] with the following main modifications:
  * - Adapted to extend Joshua's EvaluationMetric class
- * - Use of a length penalty to prevent chrF to prefer too long (with beta>1) or too short (with beta<1) translations
+ * - Use of a length penalty to prevent chrF to prefer too long (with beta %gt; 1) or too short (with beta &lt; 1) translations
  * - Use of hash tables for efficient n-gram matching
  * 
  * The metric has 2 parameters: