[various updated API docs in platform interface to avoid lines longer…

… than 80 characters and fix docs in example (#416) * updated API docs in platform interface to avoid lines longer than 80 characters * add missing letters from breaking lines in example app
MaikuB · Apr 5, 2023 · a4df377 · a4df377
1 parent 58c4fd5
commit a4df377
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/flutter_appauth/example/lib/main.dart b/flutter_appauth/example/lib/main.dart
@@ -214,11 +214,11 @@ class _MyAppState extends State<MyApp> {
         The discovery endpoint (_discoveryUrl) is used to find the
         configuration. The code challenge generation can be checked here 
         > https://github.com/MaikuB/flutter_appauth/search?q=challenge.
-        The code challenge is generated from the code verifier and only th
+        The code challenge is generated from the code verifier and only the
         code verifier is included in the result. This because to get the token
         in the method _exchangeCode (see above) we need only the code verifier
         and the authorization code.
-        Code challenge is not used according to the spe
+        Code challenge is not used according to the spec
         https://www.rfc-editor.org/rfc/rfc7636 page 9 section 4.5.
       */
       final AuthorizationResponse? result = await _appAuth.authorize(

diff --git a/flutter_appauth_platform_interface/lib/src/authorization_parameters.dart b/flutter_appauth_platform_interface/lib/src/authorization_parameters.dart
@@ -1,11 +1,14 @@
 mixin AuthorizationParameters {
-  /// Hint to the Authorization Server about the login identifier the End-User might use to log in.
+  /// Hint to the Authorization Server about the login identifier the End-User
+  /// might use to log in.
   String? loginHint;
 
-  /// List of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
+  /// List of ASCII string values that specifies whether the Authorization
+  /// Server prompts the End-User for reauthentication and consent.
   List<String>? promptValues;
 
-  /// Whether to use an ephemeral session that prevents cookies and other browser data being shared with the user's normal browser session.
+  /// Whether to use an ephemeral session that prevents cookies and other
+  /// browser data being shared with the user's normal browser session.
   ///
   /// This property is only applicable to iOS versions 13 and above.
   bool? preferEphemeralSession;

diff --git a/flutter_appauth_platform_interface/lib/src/authorization_response.dart b/flutter_appauth_platform_interface/lib/src/authorization_response.dart
@@ -10,7 +10,8 @@ class AuthorizationResponse {
   /// The authorization code.
   final String? authorizationCode;
 
-  /// The code verifier generated by AppAuth when issuing the authorization request.
+  /// The code verifier generated by AppAuth when issuing the authorization
+  /// request.
   ///
   /// Use this when exchanging the [authorizationCode] for a token.
   final String? codeVerifier;

diff --git a/flutter_appauth_platform_interface/lib/src/flutter_appauth_platform.dart b/flutter_appauth_platform_interface/lib/src/flutter_appauth_platform.dart
@@ -31,7 +31,8 @@ abstract class FlutterAppAuthPlatform extends PlatformInterface {
     _instance = instance;
   }
 
-  /// Convenience method for authorizing and then exchanges the authorization grant code.
+  /// Convenience method for authorizing and then exchanges the authorization
+  /// grant code.
   Future<AuthorizationTokenResponse?> authorizeAndExchangeCode(
       AuthorizationTokenRequest request) {
     throw UnimplementedError(