Skip to content

Commit

Permalink
Fixes errors in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@Tpt
Tpt committed Dec 16, 2020
1 parent d09362e commit 3872b5a
Show file tree
Hide file tree
Showing 10 changed files with 16 additions and 30 deletions.
4 changes: 2 additions & 2 deletions wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/helpers/Datamodel.java
View file
Expand Up @@ -889,7 +889,7 @@ public static LexemeDocument makeLexemeDocument(LexemeIdValue lexemeIdValue,
* Creates a {@link FormDocument}.
*
* If you plan to add this form to a specific lexeme,
* it might be easier to use {@link LexemeDocument#createForm}.
* it might be easier to use {@link LexemeDocument#createForm(List)}.
*
* @param formIdValue
* the id of the form that data is about
Expand All @@ -914,7 +914,7 @@ public static FormDocument makeFormDocument(FormIdValue formIdValue,
* Creates a {@link SenseDocument}.
*
* If you plan to add this sense to a specific lexeme,
* it might be easier to use {@link LexemeDocument#createSense)}.
* it might be easier to use {@link LexemeDocument#createSense(List)} )}.
*
* @param senseIdValue
* the id of the form that data is about
Expand Down
12 changes: 6 additions & 6 deletions wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/helpers/JsonDeserializer.java
View file
Expand Up @@ -71,7 +71,7 @@ public JsonDeserializer(String siteIri) {
}

/**
* Deserializes a JSON string into an {@class ItemDocument}.
* Deserializes a JSON string into an {@link ItemDocument}.
* @throws IOException
if the JSON payload is invalid
*/
Expand All @@ -80,7 +80,7 @@ public ItemDocument deserializeItemDocument(String json) throws IOException {
}

/**
* Deserializes a JSON string into a {@class PropertyDocument}.
* Deserializes a JSON string into a {@link PropertyDocument}.
* @throws IOException
if the JSON payload is invalid
*/
Expand All @@ -89,7 +89,7 @@ public PropertyDocument deserializePropertyDocument(String json) throws IOExcept
}

/**
* Deserializes a JSON string into a {@class LexemeDocument}.
* Deserializes a JSON string into a {@link LexemeDocument}.
* @throws IOException
if the JSON payload is invalid
*/
Expand All @@ -98,7 +98,7 @@ public LexemeDocument deserializeLexemeDocument(String json) throws IOException
}

/**
* Deserializes a JSON string into a {@class MediaInfoDocument}.
* Deserializes a JSON string into a {@link MediaInfoDocument}.
* @throws IOException
if the JSON payload is invalid
*/
Expand All @@ -107,7 +107,7 @@ public MediaInfoDocument deserializeMediaInfoDocument(String json) throws IOExce
}

/**
* Deserializes a JSON string into a {@class EntityDocument}.
* Deserializes a JSON string into a {@link EntityDocument}.
* @throws IOException
if the JSON payload is invalid
*/
Expand All @@ -116,7 +116,7 @@ public EntityDocument deserializeEntityDocument(String json) throws IOException
}

/**
* Deserializes a JSON string into a {@class EntityRedirectDocument}.
* Deserializes a JSON string into a {@link EntityRedirectDocument}.
* @throws IOException
if the JSON payload is invalid
*/
Expand Down
4 changes: 2 additions & 2 deletions wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/interfaces/StatementGroup.java
View file
Expand Up @@ -42,8 +42,8 @@ public interface StatementGroup extends Collection<Statement> {

/**
* Get the best statements of this group.
* These are the statements with rank {@link StatementRank::PREFERRED }
* if they exists or the one with rank {@link StatementRank::NORMAL }
* These are the statements with rank {@link StatementRank#PREFERRED}
* if they exists or the one with rank {@link StatementRank#NORMAL}
*
* @return a subset of the current StatementGroup, or null if there are no best statements
*/
Expand Down
3 changes: 0 additions & 3 deletions wdtk-examples/src/main/java/org/wikidata/wdtk/examples/ClassPropertyUsageAnalyzer.java
View file
Expand Up @@ -258,9 +258,6 @@ public int compare(
* Main method. Processes the whole dump using this processor. To change
* which dump file to use and whether to run in offline mode, modify the
* settings in {@link ExampleHelpers}.
*
* @param args
* @throws IOException
*/
public static void main(String[] args) {
ExampleHelpers.configureLogging();
Expand Down
3 changes: 0 additions & 3 deletions wdtk-examples/src/main/java/org/wikidata/wdtk/examples/GenderRatioProcessor.java
View file
Expand Up @@ -123,9 +123,6 @@ public int compare(SiteRecord o1, SiteRecord o2) {
* Main method. Processes the whole dump using this processor and writes the
* results to a file. To change which dump file to use and whether to run in
* offline mode, modify the settings in {@link ExampleHelpers}.
*
* @param args
* @throws IOException
*/
public static void main(String[] args) {
ExampleHelpers.configureLogging();
Expand Down
3 changes: 0 additions & 3 deletions wdtk-examples/src/main/java/org/wikidata/wdtk/examples/JsonSerializationProcessor.java
View file
Expand Up @@ -140,9 +140,6 @@ public static void printDocumentation() {
/**
* Closes the output. Should be called after the JSON serialization was
* finished.
*
* @throws IOException
* if there was a problem closing the output
*/
public void close() {
System.out.println("Serialized "
Expand Down
5 changes: 0 additions & 5 deletions wdtk-examples/src/main/java/org/wikidata/wdtk/examples/bots/SetLabelsForNumbersBot.java
View file
Expand Up @@ -124,11 +124,6 @@ public class SetLabelsForNumbersBot implements EntityDocumentProcessor {

/**
* Main method to run the bot.
*
* @param args
* @throws LoginFailedException
* @throws IOException
* @throws MediaWikiApiErrorException
*/
public static void main(String[] args) throws LoginFailedException, IOException {
ExampleHelpers.configureLogging();
Expand Down
4 changes: 2 additions & 2 deletions wdtk-rdf/src/main/java/org/wikidata/wdtk/rdf/PropertyRegister.java
View file
Expand Up @@ -215,8 +215,8 @@ public String getPropertyUriPattern(PropertyIdValue propertyIdValue) {
* Returns the IRI of the primitive Type of an Property for
* {@link EntityIdValue} objects.
*
* @todo this really ought to be exposed by the wdtk-datamodel
* module and reused here. The same heuristic is implemented in {@class EntityIdValueImpl}.
* TODO: this really ought to be exposed by the wdtk-datamodel
* module and reused here. The same heuristic is implemented in {@link EntityIdValueImpl}.
* @param propertyIdValue
* @param value
*/
Expand Down
2 changes: 1 addition & 1 deletion wdtk-wikibaseapi/src/main/java/org/wikidata/wdtk/wikibaseapi/WbEditingAction.java
View file
Expand Up @@ -773,7 +773,7 @@ private JsonNode performAPIAction(
}

/**
* @todo TO BE REFACTORED
* TODO: TO BE REFACTORED
* @param root
* @return
* @throws IOException
Expand Down
6 changes: 3 additions & 3 deletions wdtk-wikibaseapi/src/main/java/org/wikidata/wdtk/wikibaseapi/WbSearchEntitiesResult.java
View file
Expand Up @@ -93,7 +93,7 @@ interface Match {
*
* The language of the returned label depends on the HTTP
* <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4">
* Accept-Language header or the uselang URL parameter.
* Accept-Language</a> header or the uselang URL parameter.
*
* @return the label of the entity
*/
Expand All @@ -104,7 +104,7 @@ interface Match {
*
* The language of the returned description depends on the HTTP
* <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4">
* Accept-Language header or the uselang URL parameter.
* Accept-Language</a> header or the uselang URL parameter.
*
* @return the description
*/
Expand All @@ -120,7 +120,7 @@ interface Match {
/**
* A list of alias labels (returned only when an alias matched the query).
*
* @ return a list of aliases
* @return a list of aliases
*/
List<String> getAliases();

Expand Down

0 comments on commit 3872b5a

Please sign in to comment.