Skip to content

Fixing javadoc for Java 8 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2015
Merged

Fixing javadoc for Java 8 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/concept_expansion/v1/ConceptExpansion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/concept-expansion.html">
* Concept Expansion</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*
*/
public class ConceptExpansion extends WatsonService {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/concept_expansion/v1/model/Concept.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* This class map a Concept returned by {@link ConceptExpansion}
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class Concept {

Expand Down
2 changes: 1 addition & 1 deletion ...ava/com/ibm/watson/developer_cloud/language_identification/v1/LanguageIdentification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/language-identification.html">
* Language Identification</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class LanguageIdentification extends WatsonService {

Expand Down
2 changes: 1 addition & 1 deletion ...a/com/ibm/watson/developer_cloud/language_identification/v1/model/IdentifiedLanguage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* Language detected by the {@link LanguageIdentification} service
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class IdentifiedLanguage {

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/machine_translation/v1/MachineTranslation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/machine-translation.html">
* Machine Translation</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class MachineTranslation extends WatsonService {

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/machine_translation/v1/model/Language.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* Language utilized by the {@link MachineTranslation} service
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class Language {

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/message_resonance/v1/MessageResonance.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/message-resonance.html">
* Message Resonance</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class MessageResonance extends WatsonService {

Expand Down
5 changes: 3 additions & 2 deletions .../ibm/watson/developer_cloud/natural_language_classifier/v1/NaturalLanguageClassifier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
*
* @see <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/nl-classifier.html"> Natural Language Classifier</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class NaturalLanguageClassifier extends WatsonService {

Expand Down Expand Up @@ -170,7 +170,7 @@ public List<Classifier> getClassifiers() {

/**
* Deletes a classifier
*
* @param classifierId the classifier ID
* @see Classifier
*/
public void deleteClassifier(String classifierId) {
Expand All @@ -185,6 +185,7 @@ public void deleteClassifier(String classifierId) {
/**
* Retrieves a classifier
*
* @param classifierId the classifier ID
* @return the classifier list
* @see Classifier
*/
Expand Down
4 changes: 2 additions & 2 deletions ...a/com/ibm/watson/developer_cloud/natural_language_classifier/v1/model/Classification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* Classification class used by the {@link NaturalLanguageClassifier} service
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class Classification {

Expand Down Expand Up @@ -70,7 +70,7 @@ public void setText(String text) {
/**
* Sets the top class.
*
* @param top class
* @param topClass class
* the new top class
*/
public void setTopClass(String topClass) {
Expand Down
2 changes: 1 addition & 1 deletion .../com/ibm/watson/developer_cloud/natural_language_classifier/v1/model/ClassifiedClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* Classified class used by the {@link NaturalLanguageClassifier} service
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class ClassifiedClass {

Expand Down
2 changes: 1 addition & 1 deletion .../java/com/ibm/watson/developer_cloud/natural_language_classifier/v1/model/Classifier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
/**
* Classifier used by the {@link NaturalLanguageClassifier} service
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class Classifier {

Expand Down
2 changes: 1 addition & 1 deletion ...ava/com/ibm/watson/developer_cloud/natural_language_classifier/v1/model/TrainingData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* adapt a system to a domain (the ground truth)
*
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
* @see NaturalLanguageClassifier
*/
public class TrainingData {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* @see com.ibm.watson.developer_cloud.service.WatsonService Watson Service
* @see <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud">
* IBM Watson Developer Cloud</a>
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
package com.ibm.watson.developer_cloud;

2 changes: 1 addition & 1 deletion ...main/java/com/ibm/watson/developer_cloud/personality_insights/v2/PersonalityInsights.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/personality-insights.html">
* Personality Insights</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class PersonalityInsights extends WatsonService {

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/personality_insights/v2/model/Trait.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public double getSamplingError() {
* Sets the sampling error of the percentage based on the
* number of words in the input.
*
* @param sampling error
* @param samplingError error
* the new sampling error
*/
public void setSamplingError(double samplingError) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/question_and_answer/v1/QuestionAndAnswer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/question-answer.html">
* Question and Answer</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class QuestionAndAnswer extends WatsonService {

Expand Down
2 changes: 1 addition & 1 deletion ...ava/com/ibm/watson/developer_cloud/relationship_extraction/v1/RelationshipExtraction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* components (nouns, verbs, subjects, objects, etc.)
*
* @version v1
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
* @see <a
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/relationship-extraction.html">
* Relationship Extraction</a>
Expand Down
13 changes: 7 additions & 6 deletions src/main/java/com/ibm/watson/developer_cloud/service/Request.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,15 @@

/**
* Convenience class for constructing HTTP/HTTPS requests. <br>
* Example: <code><pre>
* Example: <pre>
* {@code
* HttpRequestBase request = Request
* .Get("/v1/translate")
* .withQuery("from", "en", "to", "es", "text", "Good Morning")
* .build();
* </pre></code>
* }</pre>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class Request {

Expand Down Expand Up @@ -329,7 +330,7 @@ private Request with(List<NameValuePair> params, Object... args) {
/**
* Adds a JSON content to the request (used with POST/PUT). This will
* encapsulate the json into a
* {@link org.apache.http.entity.StringEntity.StringEntity StringEntity}
* {@link org.apache.http.entity.StringEntity StringEntity}
* encoded with UTF-8 and use "application/json" as Content-Type
* @param json
* the JsonObject json
Expand All @@ -343,7 +344,7 @@ public Request withContent(JsonObject json) {
/**
* Adds string content to the request (used with POST/PUT). This will
* encapsulate the string into a
* {@link org.apache.http.entity.StringEntity.StringEntity StringEntity}
* {@link org.apache.http.entity.StringEntity StringEntity}
* encoded with UTF-8
*
* @param content
Expand Down Expand Up @@ -413,4 +414,4 @@ public Request withHeader(Object... args) {
public Request withQuery(Object... args) {
return with(queryParams, args);
}
}
}
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/service/WatsonService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
* Watson service abstract common functionality of various Watson Services. It
* handle authentication and default url
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
* @see <a
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/">
* IBM Watson Developer Cloud</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/service/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

* @see <a href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud">
* IBM Watson Developer Cloud</a>
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
package com.ibm.watson.developer_cloud.service;

2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/SpeechToText.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
* as more speech is heard.
*
* @version v1
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
* @see <a
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/speech-to-text.html">
* Speech to Text</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/text_to_speech/v1/TextToSpeech.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* back to the client with minimal delay.
*
* @version v1
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
* @see <a
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/text-to-speech.html">
* Text to Speech</a>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/util/MediaType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* @see <a
* href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7">HTTP/1.1
* section 3.7</a>
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class MediaType {

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/util/RequestUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* Utility functions to use when creating a {@link com.ibm.watson.developer_cloud.service.Request }
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class RequestUtil {
private static final Logger log = Logger.getLogger(RequestUtil.class
Expand Down
6 changes: 5 additions & 1 deletion src/main/java/com/ibm/watson/developer_cloud/util/ResponseUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
/**
* Utility class to manage service responses
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
* @see org.apache.http.HttpResponse HttpResponse
*/
public class ResponseUtil {
Expand Down Expand Up @@ -83,6 +83,8 @@ public static JsonElement getJsonElement(HttpResponse response) throws IOExcepti
*
* @param response
* an HTTP response
* @throws IOException If an input or output
* exception occurred
* @return the content body as JsonArray
*/
public static JsonArray getJsonArray(HttpResponse response)
Expand All @@ -97,6 +99,8 @@ public static JsonArray getJsonArray(HttpResponse response)
*
* @param response
* an HTTP response
* @throws IOException If an input or output
* exception occurred
* @return the content body as JSONArray
*/
public static JsonObject getJsonObject(HttpResponse response) throws IOException {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/watson/developer_cloud/visual_recognition/v1/VisualRecognition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* href="http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/visual-recognition.html">
* Visual Recognition</a>
*
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public class VisualRecognition extends WatsonService {

Expand Down
2 changes: 1 addition & 1 deletion src/test/java/com/ibm/watson/developer_cloud/WatsonServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

/**
* Utility class to test the Watson Services
* @author German Attanasio Ruiz <germanatt@us.ibm.com>
* @author German Attanasio Ruiz (germanatt@us.ibm.com)
*/
public abstract class WatsonServiceTest {

Expand Down