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/05/27 20:50:55 UTC
incubator-joshua git commit: fixing javadoc formatting
Repository: incubator-joshua
Updated Branches:
refs/heads/JOSHUA-252 37420cd0b -> ee4849f6a
fixing javadoc formatting
Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua/commit/ee4849f6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/ee4849f6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/ee4849f6
Branch: refs/heads/JOSHUA-252
Commit: ee4849f6ac37c649fa2d9191d14398e64023415a
Parents: 37420cd
Author: Matt Post <po...@cs.jhu.edu>
Authored: Fri May 27 16:50:53 2016 -0400
Committer: Matt Post <po...@cs.jhu.edu>
Committed: Fri May 27 16:50:53 2016 -0400
----------------------------------------------------------------------
.../joshua/decoder/ff/tm/format/MosesFormatReader.java | 8 ++++----
src/main/java/org/apache/joshua/util/FormatUtils.java | 9 ++++++---
2 files changed, 10 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/ee4849f6/src/main/java/org/apache/joshua/decoder/ff/tm/format/MosesFormatReader.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/decoder/ff/tm/format/MosesFormatReader.java b/src/main/java/org/apache/joshua/decoder/ff/tm/format/MosesFormatReader.java
index ad42f0c..0252636 100644
--- a/src/main/java/org/apache/joshua/decoder/ff/tm/format/MosesFormatReader.java
+++ b/src/main/java/org/apache/joshua/decoder/ff/tm/format/MosesFormatReader.java
@@ -29,16 +29,16 @@ import org.apache.joshua.util.io.LineReader;
* list of features, and word alignments. It works by
*
* - casting the phrase-based rules to left-branching hierarchical rules and passing them on \
- * to its parent class, {@HieroFormatReader}.
+ * to its parent class, {@link HieroFormatReader}.
* - converting the probabilities to -log probabilities
*
* There is also a tool to convert the grammars directly, so that they can be suitably packed. Usage:
*
* <pre>
- * cat PHRASE_TABLE | java -cp $JOSHUA/target/classes org.apache.joshua.decoder.ff.tm.format.MosesFormatReader > grammar
+ * cat PHRASE_TABLE | java -cp $JOSHUA/target/classes org.apache.joshua.decoder.ff.tm.format.MosesFormatReader
* </pre>
*
- * @author Matt Post <po...@cs.jhu.edu>
+ * @author Matt Post post@cs.jhu.edu
*
*/
@@ -94,7 +94,7 @@ public class MosesFormatReader extends HieroFormatReader {
/**
* Converts a Moses phrase table to a Joshua grammar.
*
- * @param args
+ * @param args the command-line arguments
*/
public static void main(String[] args) {
MosesFormatReader reader = new MosesFormatReader();
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/ee4849f6/src/main/java/org/apache/joshua/util/FormatUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/util/FormatUtils.java b/src/main/java/org/apache/joshua/util/FormatUtils.java
index 6ab58eb..ead2db7 100644
--- a/src/main/java/org/apache/joshua/util/FormatUtils.java
+++ b/src/main/java/org/apache/joshua/util/FormatUtils.java
@@ -52,6 +52,9 @@ public class FormatUtils {
/**
* Determines whether the ID represents a nonterminal. This is a trivial check, since nonterminal
* IDs are simply negative ones.
+ *
+ * @param id the vocabulary ID
+ * @return true if a nonterminal ID, false otherwise
*/
public static boolean isNonterminal(int id) {
return id < 0;
@@ -96,10 +99,10 @@ public class FormatUtils {
* Nonterminals on source and target sides are represented as [X,1], where 1 is an integer
* that links the two sides. This function extracts the index, e.g.,
*
- * getNonterminalIndex("[X,7]") -> 7
+ * getNonterminalIndex("[X,7]") produces 7
*
- * @param the nonterminal index
- * @return
+ * @param nt the nonterminal string
+ * @return the index
*/
public static int getNonterminalIndex(String nt) {
return Integer.parseInt(nt.substring(nt.indexOf(INDEX_SEPARATOR) + 1, nt.length() - 1));