diff --git a/packages/simplex_app/lib/app_routes.dart b/packages/simplex_app/lib/app_routes.dart index e905a2a7c..070dc528e 100644 --- a/packages/simplex_app/lib/app_routes.dart +++ b/packages/simplex_app/lib/app_routes.dart @@ -1,3 +1,5 @@ +/// All the named routes are mentioned here + class AppRoutes { static const splash = '/splash'; static const intro = '/intro'; diff --git a/packages/simplex_app/lib/main.dart b/packages/simplex_app/lib/main.dart index 14c42b74d..f46ec4ef3 100644 --- a/packages/simplex_app/lib/main.dart +++ b/packages/simplex_app/lib/main.dart @@ -12,6 +12,10 @@ import 'package:simplex_chat/views/scan_invitation/scan_invitation_view.dart'; import 'package:simplex_chat/views/setup_profile_view.dart'; import 'package:simplex_chat/views/splash_screen.dart'; + +/// Basic Structure is setup on [Providers] +/// Navigations are [namedRoutes] + void main() { WidgetsFlutterBinding.ensureInitialized(); runApp(const MyApp()); diff --git a/packages/simplex_app/lib/views/contacts/qr_code_details_view.dart b/packages/simplex_app/lib/views/contacts/qr_code_details_view.dart index 438c1b460..885e1e6c1 100644 --- a/packages/simplex_app/lib/views/contacts/qr_code_details_view.dart +++ b/packages/simplex_app/lib/views/contacts/qr_code_details_view.dart @@ -3,6 +3,8 @@ import 'package:qr_code_scanner/qr_code_scanner.dart'; import 'package:simplex_chat/constants.dart'; import 'package:simplex_chat/widgets/custom_btn.dart'; +/// Tap in the middle of QR Code to see the flow of contact being added in the Chat View + class QRCodeDetailsView extends StatelessWidget { final Barcode barcode; const QRCodeDetailsView({ diff --git a/packages/simplex_app/lib/views/conversation/conversation_view.dart b/packages/simplex_app/lib/views/conversation/conversation_view.dart index 15ab83835..333bf698e 100644 --- a/packages/simplex_app/lib/views/conversation/conversation_view.dart +++ b/packages/simplex_app/lib/views/conversation/conversation_view.dart @@ -5,6 +5,10 @@ import 'package:simplex_chat/views/conversation/contact_detail_conversation.dart import 'package:simplex_chat/views/conversation/group_detail_conversation.dart'; import 'package:simplex_chat/widgets/message_bubble.dart'; +/// View the details of group by tapping the [appBar] +/// Viwe the details of chat by tapping the [appBar] +/// Generate [Fake Messages] by tapping the [Message Icon] + class ConversationView extends StatefulWidget { // ignore: prefer_typing_uninitialized_variables final data; diff --git a/packages/simplex_app/lib/views/home/drawer.dart b/packages/simplex_app/lib/views/home/drawer.dart index 432b4569a..e59b82d66 100644 --- a/packages/simplex_app/lib/views/home/drawer.dart +++ b/packages/simplex_app/lib/views/home/drawer.dart @@ -2,7 +2,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_svg/flutter_svg.dart'; import 'package:provider/provider.dart'; import 'package:shared_preferences/shared_preferences.dart'; -import 'package:simplex_chat/constants.dart'; import 'package:simplex_chat/providers/drawer_providers.dart'; class MyDrawer extends StatelessWidget { @@ -49,6 +48,7 @@ class MyDrawer extends StatelessWidget { ); } + // remove the locally stored user data void _switchProfile(BuildContext context) async { SharedPreferences prefs = await SharedPreferences.getInstance(); diff --git a/packages/simplex_app/lib/views/home/home_view.dart b/packages/simplex_app/lib/views/home/home_view.dart index 70ad52281..0e770e6d5 100644 --- a/packages/simplex_app/lib/views/home/home_view.dart +++ b/packages/simplex_app/lib/views/home/home_view.dart @@ -12,6 +12,8 @@ import 'package:simplex_chat/views/home/drawer.dart'; import 'package:simplex_chat/views/invitations/invitation_view.dart'; import 'package:simplex_chat/views/profile/profile_view.dart'; +/// Generate [Fake Contacts] by tapping the [Bug Icon] + class HomeView extends StatefulWidget { final double maxSlide; const HomeView({Key? key, required this.maxSlide}) : super(key: key); diff --git a/packages/simplex_app/lib/views/setup_profile_view.dart b/packages/simplex_app/lib/views/setup_profile_view.dart index 9a77ea0d7..6e8763d80 100644 --- a/packages/simplex_app/lib/views/setup_profile_view.dart +++ b/packages/simplex_app/lib/views/setup_profile_view.dart @@ -161,7 +161,7 @@ class _SetupProfileViewState extends State { ); } - // create profile and store in local + // create profile and save the data locally to access across the app Future _createProfile() async { SharedPreferences prefs = await SharedPreferences.getInstance(); await prefs.setString('displayName', _displayNameController.text.trim()); diff --git a/packages/simplex_app/lib/views/splash_screen.dart b/packages/simplex_app/lib/views/splash_screen.dart index fb9cf3619..fd3743db0 100644 --- a/packages/simplex_app/lib/views/splash_screen.dart +++ b/packages/simplex_app/lib/views/splash_screen.dart @@ -39,10 +39,7 @@ class _SplashScreenState extends State { EntranceFader( duration: const Duration(seconds: 1), offset: const Offset(0, 15), - child: SvgPicture.asset( - 'assets/logo.svg', - height: 85, - ), + child: SvgPicture.asset('assets/logo.svg', height: 85), ), EntranceFader( offset: const Offset(0, 0),