Skip to content

Commit 11839ba

Browse files
authored
chore: add missing doc comment to Auth signOut API (#1571)
1 parent 5454bc3 commit 11839ba

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Amplify/Categories/Auth/AuthCategoryBehavior.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,12 @@ public protocol AuthCategoryBehavior: AuthCategoryUserBehavior, AuthCategoryDevi
114114
options: AuthConfirmSignInOperation.Request.Options?,
115115
listener: AuthConfirmSignInOperation.ResultListener?) -> AuthConfirmSignInOperation
116116

117+
/// Sign out the currently logged-in user.
118+
///
119+
/// - Parameters:
120+
/// - options: Parameters specific to plugin behavior.
121+
/// - listener: Triggered when the operation completes.
122+
/// - Returns: AuthSignOutOperation
117123
@discardableResult
118124
func signOut(options: AuthSignOutOperation.Request.Options?,
119125
listener: AuthSignOutOperation.ResultListener?) -> AuthSignOutOperation

0 commit comments

Comments
 (0)