Skip to content

Commit b3c8f1c

Browse files
author
Ben McLean
committed
Added more documentation
1 parent 198a3b1 commit b3c8f1c

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

src/au/com/origma/perspectiveapi/v1alpha1/UnirestPerspectiveAPI.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ public class UnirestPerspectiveAPI implements PerspectiveAPI {
2424
String apiKey;
2525
boolean doNotStore = true;
2626

27+
/**
28+
* Create a new instance of UnirestPerspectiveAPI
29+
* @param apiKey Your Google API Key
30+
*/
2731
public UnirestPerspectiveAPI(String apiKey) {
2832
super();
2933
this.apiKey = apiKey;
@@ -54,10 +58,18 @@ public AnalyzeCommentResponse analyze(String comment) {
5458
.build());
5559
}
5660

61+
/**
62+
* If the simple analysis will default to do not store
63+
* @return the simple analysis will default to do not store
64+
*/
5765
public boolean isDoNotStore() {
5866
return doNotStore;
5967
}
6068

69+
/**
70+
* The default do not store setting
71+
* @param doNotStore The default do not store setting
72+
*/
6173
public void setDoNotStore(boolean doNotStore) {
6274
this.doNotStore = doNotStore;
6375
}

0 commit comments

Comments
 (0)