Skip to content

Commit bae9bd8

Browse files
authored
Merge pull request #59 from SparkPost/feature/httpclient_4_5_3_compat_issue57
Fixes some javadoc errors
2 parents 2828ad0 + 4a01a1d commit bae9bd8

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

libs/sparkpost-lib/src/main/java/com/sparkpost/transport/IRestConnection.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public interface IRestConnection {
3131
* Perform an HTTP GET request. This method throws an exception if the
3232
* server returns anything else than a 200.
3333
*
34-
* @param path
34+
* @param endpoint
3535
* API endpoint to send the request to.
3636
* @return Server response to the request.
3737
* @throws SparkPostException
@@ -58,11 +58,11 @@ public interface IRestConnection {
5858
* Perform an HTTP POST request. This method throws an exception if the
5959
* server returns anything else than a 200.
6060
*
61-
* @param path
61+
* @param endpoint
6262
* API endpoint to send the request to.
6363
* @param json
6464
* POST data block to send with the request. May be null.
65-
* @return Server response to the request.
65+
* @return Server response to the request
6666
* @throws SparkPostException
6767
* if something goes wrong
6868
*/
@@ -88,7 +88,7 @@ public interface IRestConnection {
8888
* Perform an HTTP PUT request. This method throws an exception if the
8989
* server returns anything else than a 200.
9090
*
91-
* @param path
91+
* @param endpoint
9292
* API endpoint to send the request to.
9393
* @param json
9494
* PUT data block to send with the request. May be null.

libs/sparkpost-lib/src/main/java/com/sparkpost/transport/RestConnection.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,22 @@ public enum Method {
6363
* @param client
6464
* Client object to use (in particular for authentication info)
6565
* @throws SparkPostException
66+
* if something goes wrong
6667
*/
6768
public RestConnection(Client client) throws SparkPostException {
6869
this(client, "" /* means:set to default endpoint */);
6970
}
7071

7172
/**
72-
* Create a REST connection object. The given {@link endpoint} will be used
73+
* Create a REST connection object. The given baseUrl will be used
7374
* for connections
7475
*
7576
* @param client
7677
* Client object to use (in particular for authentication info)
7778
* @param baseUrl
7879
* Endpoint to use instead of the default defaultApiEndpoint
7980
* @throws SparkPostException
81+
* if something goes wrong
8082
*/
8183
public RestConnection(Client client, String baseUrl) throws SparkPostException {
8284

@@ -102,6 +104,7 @@ public RestConnection(Client client, String baseUrl) throws SparkPostException {
102104
* HTTP method for the connection
103105
* @return the connection object
104106
* @throws SparkPostException
107+
* if something goes wrong
105108
*/
106109
private HttpURLConnection createConnectionObject(String path, Method method) throws SparkPostException {
107110
HttpURLConnection conn;

0 commit comments

Comments
 (0)