Skip to content

Commit 8f9ce96

Browse files
docs(javadoc): reviewed javadoc comments
1 parent 7579b08 commit 8f9ce96

File tree

4 files changed

+12
-3
lines changed

4 files changed

+12
-3
lines changed

src/main/java/net/hexonet/apiconnector/APIClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public String getURL() {
132132
/**
133133
* Get the current module version
134134
*
135-
* @returns module version
135+
* @return module version
136136
*/
137137
public String getVersion() {
138138
return "1.3.20";

src/main/java/net/hexonet/apiconnector/Column.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ public class Column {
1919

2020
/**
2121
* Class constructor.
22+
*
23+
* @param key column name
24+
* @param data column data as list
2225
*/
2326
public Column(String key, ArrayList<String> data) {
2427
this.data = new ArrayList<String>(data);
@@ -47,6 +50,7 @@ public ArrayList<String> getData() {
4750
/**
4851
* Get data for given column index
4952
*
53+
* @param idx column data index
5054
* @return data for given column index
5155
*/
5256
public String getDataByIndex(int idx) {

src/main/java/net/hexonet/apiconnector/Record.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ public class Record {
1515
private Map<String, String> data;
1616

1717
/**
18-
* Class constructor.
18+
* Class constructor
19+
*
20+
* @param data row data as associative array
1921
*/
2022
public Record(Map<String, String> data) {
2123
this.data = new HashMap<String, String>(data);
@@ -33,6 +35,7 @@ public Map<String, String> getData() {
3335
/**
3436
* Get data for given golumn name
3537
*
38+
* @param key column name
3639
* @return data for given column name
3740
*/
3841
public String getDataByKey(String key) {

src/main/java/net/hexonet/apiconnector/ResponseTemplate.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ public class ResponseTemplate {
1717
protected Map<String, Object> hash;
1818

1919
/**
20-
* Class constructor.
20+
* Class constructor
21+
*
22+
* @param raw plain API response text
2123
*/
2224
public ResponseTemplate(String raw) {
2325
if (raw.length() == 0) {

0 commit comments

Comments
 (0)