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 2017/03/02 18:02:37 UTC
incubator-joshua git commit: Fixed javadoc
Repository: incubator-joshua
Updated Branches:
refs/heads/master 1386f4f7f -> 47e0d6cf6
Fixed javadoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua/commit/47e0d6cf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/47e0d6cf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/47e0d6cf
Branch: refs/heads/master
Commit: 47e0d6cf6a7dc8e0ca257c0a1ed3904e80f14073
Parents: 1386f4f
Author: Matt Post <po...@cs.jhu.edu>
Authored: Thu Mar 2 13:02:35 2017 -0500
Committer: Matt Post <po...@cs.jhu.edu>
Committed: Thu Mar 2 13:02:35 2017 -0500
----------------------------------------------------------------------
.../java/org/apache/joshua/decoder/JoshuaConfiguration.java | 5 +++++
src/main/java/org/apache/joshua/server/ServerThread.java | 9 +++++----
2 files changed, 10 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/47e0d6cf/src/main/java/org/apache/joshua/decoder/JoshuaConfiguration.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/decoder/JoshuaConfiguration.java b/src/main/java/org/apache/joshua/decoder/JoshuaConfiguration.java
index 3532241..f882e2e 100644
--- a/src/main/java/org/apache/joshua/decoder/JoshuaConfiguration.java
+++ b/src/main/java/org/apache/joshua/decoder/JoshuaConfiguration.java
@@ -374,6 +374,8 @@ public class JoshuaConfiguration {
* This records the path of the config file passed as a command-line argument
* (-c or -config). It is used to produce absolute path names when relative ones are found
* in the config file.
+ *
+ * @param path the root path for the joshua models
*/
public void setConfigFilePath(String path) {
this.modelRootPath = path;
@@ -383,6 +385,9 @@ public class JoshuaConfiguration {
* Returns the absolute file path of the argument. Files that are already absolute path names
* are returned unmodified, but relative file names have the `modelRootPath` prepended (if
* it was set).
+ *
+ * @param filename the path of the file, absolute or relative
+ * @return the absolute file path of a file
*/
public String getFilePath(String filename) {
if (filename.startsWith("/"))
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/47e0d6cf/src/main/java/org/apache/joshua/server/ServerThread.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/joshua/server/ServerThread.java b/src/main/java/org/apache/joshua/server/ServerThread.java
index a774f7f..49dd3c6 100644
--- a/src/main/java/org/apache/joshua/server/ServerThread.java
+++ b/src/main/java/org/apache/joshua/server/ServerThread.java
@@ -113,9 +113,9 @@ public class ServerThread extends Thread implements HttpHandler {
* Transforms an HTTP query string into a dictionary of lists of values. The lists are necessary
* because the RESTful spec permits multiple keys of the same name.
*
- * @param query
- * @return
- * @throws UnsupportedEncodingException
+ * @param query the query string
+ * @return a map of lists of values found for each key in the query string
+ * @throws UnsupportedEncodingException if there is a bad encoding
*/
public HashMap<String, ArrayList<String>> queryToMap(String query) throws UnsupportedEncodingException {
HashMap<String, ArrayList<String>> result = new HashMap<>();
@@ -162,7 +162,7 @@ public class ServerThread extends Thread implements HttpHandler {
* but only multiple "q=" keys are permitted. If multiple keys of other names are found, only the
* last one is used. So for the query string:
*
- * ?q=a&q=b&meta=c&meta=d
+ * ?q=a&q=b&meta=c&meta=d
*
* handle() will use q = {a, b} and meta = {d}
*
@@ -204,6 +204,7 @@ public class ServerThread extends Thread implements HttpHandler {
* Processes metadata commands received in the HTTP request. Some commands result in sending data back.
*
* @param meta the metadata request
+ * @param message the JSON message template that will be filled out.
*/
private void handleMetadata(String meta, JSONMessage message) {
String[] tokens = meta.split("\\s+", 2);