Skip to content

Commit 5e0c499

Browse files
author
Takayuki Otake
committed
add @throws to JavaDoc, rather than to method signature
1 parent 706f0d6 commit 5e0c499

File tree

3 files changed

+21
-4
lines changed

3 files changed

+21
-4
lines changed

StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/api/StudyplusApi.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@
1111
*/
1212
public class StudyplusApi {
1313

14-
public static ApiClient getClient(Context context) throws AccessTokenNotFound {
14+
/**
15+
* @param context Specifies application context.
16+
* @return client for StudyplusAPI
17+
* @throws AccessTokenNotFound
18+
*/
19+
public static ApiClient getClient(Context context) {
1520
ApiCertification certification = CertificationStore.create(context).getDefault();
1621
return new ApiClient(certification);
1722
}

StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/auth/AuthTransit.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,14 @@ public AuthTransit setRequestCode(int requestCode){
2525
return new AuthTransit(activity, requestCode);
2626
}
2727

28-
public void startActivity(String consumerKey, String consumerSecret)
29-
throws ActivityNotFoundException {
28+
/**
29+
* Start the certification {@link Activity} for API.
30+
*
31+
* @param consumerKey for API
32+
* @param consumerSecret for API
33+
* @throws ActivityNotFoundException when not installed Studyplus application or un-supported version.
34+
*/
35+
public void startActivity(String consumerKey, String consumerSecret) {
3036
Intent intent = new Intent();
3137
intent.setAction(Intent.ACTION_VIEW);
3238
intent.putExtra("consumer_key", consumerKey);

StudyplusAndroidSDK/src/main/java/jp/studyplus/android/sdk/service/auth/CertificationStore.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,13 @@ private Optional<String> findAccessToken(){
4646
return Optional.fromNullable(preferences.getString(KEY_ACCESS_TOKEN, null));
4747
}
4848

49-
public ApiCertification getDefault() throws AccessTokenNotFound {
49+
/**
50+
* Return the basic {@link ApiCertification} instance for API.
51+
*
52+
* @return certification instance for API.
53+
* @throws AccessTokenNotFound
54+
*/
55+
public ApiCertification getDefault() {
5056
Optional<String> token = findAccessToken();
5157
if (!token.isPresent()){
5258
throw new AccessTokenNotFound();

0 commit comments

Comments
 (0)