Nilesh has uploaded a new change for review.
https://gerrit.wikimedia.org/r/75663
Change subject: Fixed a few small errors in docs
......................................................................
Fixed a few small errors in docs
Change-Id: Id546a269155cc3ce447387380d072cd9dee3b5cb
---
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/CLIClientRecommender.java
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/WebClientRecommender.java
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/WikiPageInputFormat.java
M
client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/XMLInputFormat.java
5 files changed, 16 insertions(+), 28 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikidataEntitySuggester
refs/changes/63/75663/1
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/CLIClientRecommender.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/CLIClientRecommender.java
index 2ee20f9..52be09e 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/CLIClientRecommender.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/CLIClientRecommender.java
@@ -57,7 +57,8 @@
* @param recommendTo
* @param recommendType
* @param howMany
- * @return
+ * @return List of TranslatedRecommendedItems, the suggested
+ * wikibaseProperties
*/
@Override
public List<TranslatedRecommendedItem> recommend(String idListFile, String
recommendTo, String recommendType, int howMany) {
@@ -80,7 +81,8 @@
* @param recommendType
* @param howMany
* @param list
- * @return
+ * @return List of TranslatedRecommendedItems, the suggested
+ * wikibaseProperties
*/
@Override
public List<TranslatedRecommendedItem> recommendAnonymous(String
idListFile, String recommendType, int howMany, String[] list) {
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/WebClientRecommender.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/WebClientRecommender.java
index c480ded..945e325 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/WebClientRecommender.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/recommender/WebClientRecommender.java
@@ -50,7 +50,8 @@
* @param recommendTo
* @param recommendType
* @param howMany
- * @return
+ * @return List of TranslatedRecommendedItems, the suggested
+ * wikibaseProperties
* @throws TasteException
*/
@Override
@@ -66,7 +67,8 @@
* @param recommendType
* @param howMany
* @param list
- * @return
+ * @return List of TranslatedRecommendedItems, the suggested
+ * wikibaseProperties
* @throws TasteException
*/
@Override
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
index 3343eca..5b1e961 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/client/servlets/AbstractEntitySuggesterServlet.java
@@ -18,7 +18,7 @@
/**
* Base class for all client servlets
*
- * @author nilesh
+ * @author Nilesh Chakraborty
*/
public abstract class AbstractEntitySuggesterServlet extends
AbstractMyrrixServlet {
@@ -55,7 +55,7 @@
/**
*
- * @return
+ * @return the WebClientRecommender instance
*/
protected final WebClientRecommender getClientRecommender() {
return recommender;
@@ -66,7 +66,7 @@
* file name is set in the WAR's web.xml
*
* @param name
- * @return
+ * @return URL of the wikibaseProperty list file
* @throws NamingException
*/
protected final URL getPropFilePath(String name) throws NamingException {
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/WikiPageInputFormat.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/WikiPageInputFormat.java
index ce39518..e269694 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/WikiPageInputFormat.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/WikiPageInputFormat.java
@@ -26,7 +26,7 @@
* @param split
* @param conf
* @param reporter
- * @return
+ * @return RecordReader for Hadoop
* @throws IOException
*/
@Override
diff --git
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/XMLInputFormat.java
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/XMLInputFormat.java
index 4c44e8f..2a67864 100644
---
a/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/XMLInputFormat.java
+++
b/client/src/main/java/org/wikimedia/wikibase/entitysuggester/wikiparser/XMLInputFormat.java
@@ -50,7 +50,7 @@
* @param inputSplit
* @param jobConf
* @param reporter
- * @return
+ * @return RecordReader for Hadoop
* @throws IOException
*/
@Override
@@ -130,7 +130,7 @@
*
* @param key
* @param value
- * @return
+ * @return true if next key value pair is found
* @throws IOException
*/
@Override
@@ -171,19 +171,11 @@
return false;
}
- /**
- *
- * @return
- */
@Override
public LongWritable createKey() {
return new LongWritable();
}
- /**
- *
- * @return
- */
@Override
public Text createValue() {
return new Text();
@@ -191,7 +183,7 @@
/**
*
- * @return @throws IOException
+ * @throws IOException
*/
@Override
public long getPos() throws IOException {
@@ -209,25 +201,17 @@
/**
*
- * @return @throws IOException
+ * @throws IOException
*/
@Override
public float getProgress() throws IOException {
return ((float) (pos - start)) / ((float) (end - start));
}
- /**
- *
- * @return
- */
public long getStart() {
return start;
}
- /**
- *
- * @return
- */
public long getEnd() {
return end;
}
--
To view, visit https://gerrit.wikimedia.org/r/75663
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Id546a269155cc3ce447387380d072cd9dee3b5cb
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikidataEntitySuggester
Gerrit-Branch: master
Gerrit-Owner: Nilesh <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
