Skip to content

Commit ff06584

Browse files
committed
add comment
1 parent 222ef05 commit ff06584

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

StudyplusSDK/Studyplus.swift

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,14 +230,16 @@ final public class Studyplus {
230230
}
231231

232232
/// Change the consumer key and secret.
233-
/// You can call this method to switch to a different key when logging in to Studyplus or posting study records.
233+
/// Calling this method allows you to switch to another consumer key and secret. For example, you log in to Studyplus, log out, and post a study record.
234234
/// If multiple applications are connected with Studyplus, you need to call this method.
235235
/// If there is only one connected application, you do not need to call this method.
236+
/// If multiple applications are connected with Studyplus, do not forget to set up custom URL schemes.
236237
///
237238
/// StudyplusAPI用のConsumer Key と Secret を変更します。
238-
/// このメソッドを呼ぶと、Studyplusにログインしたり、勉強記録を投稿するときに別の Consumer Key と Secret に切り替えることができます。
239-
/// 複数のアプリケーションがStudyplusと連携されている場合は、このメソッドを呼ぶ必要があります。
239+
/// このメソッドを呼ぶとStudyplusにログイン、ログアウト、勉強記録を投稿するときなどに、別の Consumer Key と Secret に切り替えることができます。
240+
/// 複数のアプリケーションがStudyplusと連携している場合は、このメソッドを呼ぶ必要があります。
240241
/// 連携されたアプリケーションが1つしかない場合は、このメソッドを呼ぶ必要はありません。
242+
/// 複数のアプリケーションがStudyplusと連携している場合は、カスタムURLスキーマの設定を忘れないように注意してください。
241243
///
242244
/// - Parameter
243245
/// - consumerKey: consumer key

0 commit comments

Comments
 (0)