Skip to content

Commit

Permalink
docs: updated docs for onboarding screens
Browse files Browse the repository at this point in the history
  • Loading branch information
sachins-geekyants committed Oct 31, 2023
1 parent 1c79b22 commit 43aa289
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import 'package:at_sync_ui_flutter/at_sync_material.dart';
import 'package:flutter/material.dart';
import 'package:url_launcher/url_launcher.dart';

/// This screen for activating an atSign during onboarding
/// This screen is for activating an atSign during onboarding process
class AtOnboardingActivateScreen extends StatefulWidget {
/// If true, will hide webpage references
final bool hideReferences;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import 'package:at_onboarding_flutter/utils/at_onboarding_strings.dart';
import 'package:at_onboarding_flutter/widgets/at_onboarding_button.dart';
import 'package:flutter/material.dart';

/// This screen for backing up an @ sign key during onboarding
/// This screen is for backing up an atKey during onboarding
class AtOnboardingBackupScreen extends StatefulWidget {
/// Configuration for the onboarding process
final AtOnboardingConfig config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import 'package:flutter/material.dart';
import 'package:tutorial_coach_mark/tutorial_coach_mark.dart';
import 'package:url_launcher/url_launcher.dart';

/// This screen for generating an new atSign key during onboarding
/// This screen is for generating atKey
class AtOnboardingGenerateScreen extends StatefulWidget {
/// Callback function to be called when generation is successful
/// Callback function to be called when atKey generation is successful
/// It receives the generated atSign and its corresponding secret
final Function({
required String atSign,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import 'package:url_launcher/url_launcher.dart';
import 'package:zxing2/qrcode.dart';
import 'package:image/image.dart' as img;

/// The home screen for the At Onboarding process
/// Home screen provides multiple options like upload atKey, generate new atSign, activatte existing atSign
class AtOnboardingHomeScreen extends StatefulWidget {
/// Configuration for the onboarding process
final AtOnboardingConfig config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import 'package:at_onboarding_flutter/widgets/at_onboarding_button.dart';
import 'package:flutter/material.dart';
import 'package:url_launcher/url_launcher.dart';

/// The input screen for the atSign during the At onboarding process
/// [AtOnboardingInputAtSignScreen] allows to enter atSign for activation process
class AtOnboardingInputAtSignScreen extends StatefulWidget {
/// Configuration for the onboarding process
final AtOnboardingConfig config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:url_launcher/url_launcher.dart';

/// The introductory screen for the At Onboarding process
/// The introductory screen for the at onboarding process
/// [AtOnboardingIntroScreen] gives two options
/// 1. Already have an atSign - proceeds to home screen to upload atKey
/// 2. Get a free atSign - proceeds to generate free atSign
class AtOnboardingIntroScreen extends StatefulWidget {
/// Configuration for the onboarding process
final AtOnboardingConfig config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class AtOnboardingOTPResult {
});
}

/// This screen for perform OTP-based verification
/// This screen is to perform OTP-based verification
class AtOnboardingOTPScreen extends StatefulWidget {
/// Static method to navigate to this screen
static Future<AtOnboardingOTPResult?> push({
Expand Down Expand Up @@ -630,4 +630,4 @@ class _AtOnboardingOTPScreenState extends State<AtOnboardingOTPScreen> {
},
);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:url_launcher/url_launcher.dart';

/// This screen for pairing an atSign during onboarding process
/// This screen is for pairing an atSign during onboarding process
class AtOnboardingPairScreen extends StatefulWidget {
/// The atSign to be paired
final String atSign;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'package:flutter/material.dart';
import 'package:webview_flutter/webview_flutter.dart';

/// Displays onboarding reference screens
/// It uses weview to display the [url]
class AtOnboardingReferenceScreen extends StatefulWidget {
/// Static method to navigate to this screen
static push({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import 'package:at_onboarding_flutter/widgets/at_onboarding_dialog.dart';
import 'package:flutter/material.dart';
import 'package:at_onboarding_flutter/at_onboarding_result.dart';

/// The screen used for resetting the atSign keys during the onboarding process
/// The screen is used for resetting the paired atSign
class AtOnboardingResetScreen extends StatefulWidget {
/// Configuration for the onboarding process
final AtOnboardingConfig config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import 'package:at_onboarding_flutter/localizations/generated/l10n.dart';
import 'package:flutter/material.dart';
import 'package:webview_flutter/webview_flutter.dart';

/// The screen for showing WebView during the onboarding process
/// This screen is for showing WebView during the onboarding process
class AtOnboardingWebviewScreen extends StatefulWidget {
/// The URL to be displayed
final String? url;
Expand Down

0 comments on commit 43aa289

Please sign in to comment.