Skip to content
This repository was archived by the owner on Jan 31, 2022. It is now read-only.

Commit 5ef88a0

Browse files
committed
Documentation: Indent/Corrections
1 parent 26f8a01 commit 5ef88a0

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

algoliasearch/src/main/java/com/algolia/search/saas/BaseAPIClient.java

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,12 @@ abstract class BaseAPIClient {
6464

6565
/**
6666
* Algolia Search initialization
67+
*
6768
* @param applicationID the application ID you have in your admin interface
68-
* @param apiKey a valid API key for the service
69-
* @param hostsArray the list of hosts that you have received for the service
70-
* @param enableDsn set to true if your account has the Distributed Search Option
71-
* @param dsnHost override the automatic computation of dsn hostname
69+
* @param apiKey a valid API key for the service
70+
* @param hostsArray the list of hosts that you have received for the service
71+
* @param enableDsn set to true if your account has the Distributed Search Option
72+
* @param dsnHost override the automatic computation of dsn hostname
7273
*/
7374
protected BaseAPIClient(String applicationID, String apiKey, List<String> hostsArray, boolean enableDsn, String dsnHost) {
7475
if (applicationID == null || applicationID.length() == 0) {
@@ -103,8 +104,9 @@ public void setExtraHeader(String key, String value) {
103104

104105
/**
105106
* Allow to set timeout
107+
*
106108
* @param connectTimeout connection timeout in MS
107-
* @param readTimeout socket timeout in MS
109+
* @param readTimeout socket timeout in MS
108110
*/
109111
public void setTimeout(int connectTimeout, int readTimeout) {
110112
httpSocketTimeoutMS = readTimeout;
@@ -113,9 +115,10 @@ public void setTimeout(int connectTimeout, int readTimeout) {
113115

114116
/**
115117
* Allow to set timeout
118+
*
116119
* @param connectTimeout connection timeout in MS
117-
* @param readTimeout socket timeout in MS
118-
* @param searchTimeout socket timeout in MS
120+
* @param readTimeout socket timeout in MS
121+
* @param searchTimeout socket timeout in MS
119122
*/
120123
public void setTimeout(int connectTimeout, int readTimeout, int searchTimeout) {
121124
httpSocketTimeoutMS = readTimeout;
@@ -133,6 +136,7 @@ public void setUserToken(String userToken) {
133136

134137
/**
135138
* List all existing indexes
139+
*
136140
* @return a JSON Object in the form:
137141
* { "items": [ {"name": "contacts", "createdAt": "2013-01-18T15:33:13.556Z"},
138142
* {"name": "notes", "createdAt": "2013-01-18T15:33:13.556Z"}]}
@@ -157,6 +161,7 @@ protected JSONObject deleteIndex(String indexName) throws AlgoliaException {
157161

158162
/**
159163
* Move an existing index.
164+
*
160165
* @param srcIndexName the name of index to copy.
161166
* @param dstIndexName the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
162167
*/
@@ -175,6 +180,7 @@ protected JSONObject moveIndex(String srcIndexName, String dstIndexName) throws
175180

176181
/**
177182
* Copy an existing index.
183+
*
178184
* @param srcIndexName the name of index to copy.
179185
* @param dstIndexName the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
180186
*/
@@ -193,8 +199,9 @@ protected JSONObject copyIndex(String srcIndexName, String dstIndexName) throws
193199

194200
/**
195201
* Return last logs entries.
196-
* @param offset Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
197-
* @param length Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
202+
*
203+
* @param offset Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
204+
* @param length Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
198205
* @param logType Specify the type of log to retrieve
199206
*/
200207
protected JSONObject getLogs(int offset, int length, LogType logType) throws AlgoliaException {
@@ -318,15 +325,15 @@ protected JSONObject putRequest(String url, String obj) throws AlgoliaException
318325
}
319326

320327
/**
321-
* Reads the answer and return it as a String
328+
* Reads the answer and return it as a String
322329
*
323330
* @param istream the InputStream to read
324331
* @return the stream's content
325332
* @throws IOException
326333
*/
327334
private String _getAnswer(InputStream istream) throws IOException {
328335
InputStreamReader is = new InputStreamReader(istream, "UTF-8");
329-
StringBuilder builder= new StringBuilder();
336+
StringBuilder builder = new StringBuilder();
330337
char[] buf = new char[1000];
331338
int l = 0;
332339
while (l >= 0) {

0 commit comments

Comments
 (0)