Issue - 275 (Meaningful Documentation) #286

Ivan2001otp · 2024-02-29T17:59:00Z

Description

This PR involves creating meaningful documentation for the codebase of Flutter app -Resonate .It provides convenient way to understand the code . Tried to explain the key functionalities , wherever it is necessary.

Fixes # (issue)
Issues-275.

Type of change

Documentation update.

Documentation update

Please include screenshots below if applicable.
No screenshots in documentation update.

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules
I have checked my code and corrected any misspellings

Maintainer Checklist

closes DOC: Document the code so that newer developers are easily able to understand the code #275 (Replace xxxx with the GitHub issue number)
Documentation Update

Ivan2001otp · 2024-02-29T18:00:51Z

Please provide me the feedback , whether the documentation provided meets the expectation , if not feel free to provide me constructive suggestion.Thank you.

opxdelwin

Hello @Ivan2001otp,

I wanted to commend you on your exceptional work in this area. While reviewing, I noticed several documentation format issues that, if addressed, would greatly enhance the ease of understanding for new users. Kindly consider incorporating these adjustments as needed.

Thank you for your attention to this matter.

opxdelwin · 2024-03-03T18:27:05Z

lib/controllers/auth_state_controller.dart

+  /*
+  - Sets up Android notification settings.
+  - Registers callback to handle Notification taps(onDidRecieveNotificationResponse)
+  - Enables overall notification capability.
+  */


All Dart documentation must be written using ///. This practice ensures that contributors can quickly understand the functionality of a function by hovering over it.

opxdelwin · 2024-03-03T18:27:22Z

lib/controllers/auth_state_controller.dart

+    4.Make the ScrollController to get initialized to that offset.
+    5.Update tab Controller to switch to discussions tab.
+    6.Navigate user to the tabs screen.
+   */


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:28:16Z

lib/controllers/auth_state_controller.dart

@@ -119,6 +138,11 @@ class AuthStateController extends GetxController {
    }
  }

+  /*


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:28:24Z

lib/controllers/auth_state_controller.dart

@@ -146,12 +170,27 @@ class AuthStateController extends GetxController {
    }
  }

+  /*


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:28:41Z

lib/controllers/auth_state_controller.dart

  Future<String> getAppwriteToken() async {
    Jwt authToken = await account.createJWT();
    log(authToken.toString());
    return authToken.jwt;
  }

+  /*


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:38:34Z

lib/services/api_service.dart

+  /*
+    This service helps to create a new room for meeting , by providing necessary parameters
+    and returns future.
+   */


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:38:44Z

lib/services/api_service.dart

+  /*
+    This service helps to join the created chat rooms,and returns the status 
+    of task in Future.
+   */


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:38:52Z

lib/services/room_service.dart

+  /*
+    - Constructs a liveKitController with the given URI and roomToken
+      in its constructor parameters.
+    - Registers the controller as a permanent , singleton Instance via Get.
+    - Get.put() -> Its a dependency injection to register new instance.
+    - Returns a future that completes when this is done. 
+   */


DartDocs, as mentioned

opxdelwin · 2024-03-03T18:39:17Z

lib/themes/choose_theme_bottom_sheet.dart

+/*
+  This below Widget function provides a Widget UI, to user 
+  that helps to choos the type of theme system default , light or dark theme.
+ */


DartDocs, as mentioned

correct "choos" to "choose"

opxdelwin · 2024-03-03T18:39:30Z

lib/themes/theme_controller.dart

+  /*
+    - This code retrieves the currently selected theme for the application.
+    - It prioritizes loading previously saved user preference,but defaults to system's default theme,
+      if a preference is not found.
+   */


DartDocs, as mentioned

Aarush-Acharya · 2024-05-24T07:24:51Z

Hey @Ivan2001otp thank you for your contribution, Great Work 🚀✨

Please do implement the suggested changes and push again, along with solving the merge conflicts with the current state of the repository.

We await your reply as a token of acknowledgement, will merge once the requested changes are done

P.S. Make this done ASAP as these are just documentation related changes should not take much time, also resolve the conflicts carefully, I will try to get this merged by tomorrow

Aarush-Acharya · 2024-05-23T14:23:46Z

lib/controllers/auth_state_controller.dart

  Future<String> getAppwriteToken() async {
    Jwt authToken = await account.createJWT();
    log(authToken.toString());
    return authToken.jwt;
  }

+  /*
+    In the below method(isUserLoggedIn)
+    - all we are trying to know is whether the userProfile is successfully setup or not.


and if the user is logged in or not, this goal is not highlighted make it more clear

Aarush-Acharya · 2024-05-23T18:24:57Z

lib/controllers/auth_state_controller.dart

@@ -195,6 +234,16 @@ class AuthStateController extends GetxController {
    });
  }

+/*
+  1. Get the current FCM token for the user's device.
+  2. Fetch the list of subscribed Discussion from appwrite collection.


Make this,
2. Fetch the List of subscriptions made by this user
3. Loop through the subscriptions
4. Removing the FCM token of this device from the list of FCM tokens of each subscription
5. A FCM token in the list of FCM tokens of a subscription created by this user represents a device to which notification is to be sent on events related to the discussion subscription was made to as the user can login from many devices and if user is logged in through 3 different devices all of them needs to be sent notifications

Aarush-Acharya · 2024-05-24T06:34:06Z

lib/controllers/email_verify_controller.dart

+    This below method helps to verify the user entered otp
+
+    Purpose of imp variables used in below code:
+    - otpId =>Retrieves the otp from user's document, representing the actual OTP.


otpId: the ID of the otp sent, which will help fetch the actual otp from server side.

prefs: Fetch the user account prefs to get the otpId from it, the otpID gets updated into user account prefs when an otp is sent to the user. It is the Id corresponding to the otp sent to the user

verificationId: After comparison between OTP sent and user entered OTP the server side updates the status of the verification in the verification document (each verification is represented by a document in the verification collection ), status is then used to check if the verification was successful or not

Aarush-Acharya · 2024-05-24T06:55:25Z

lib/services/room_service.dart

  static Future<void> joinLiveKitRoom(
      String livekitUri, String roomToken) async {
    Get.put(LiveKitController(liveKitUri: livekitUri, roomToken: roomToken),
        permanent: true);
  }

+  /*
+   - This below method performs the task of updating/adds the total number


Adds a new participant as a document to the collection of all participants.

roomID: represents the room to which the particiapant belongs
userID: who the participant is

Aarush-Acharya · 2024-05-24T07:00:36Z

lib/services/room_service.dart

@@ -32,6 +43,11 @@ class RoomService {
          Query.equal("uid", [uid]),
          Query.equal('roomId', [roomId])
        ]);
+
+    /*
+      We delete the previous participants data of past meeting , so that


We delete the participant documents that have the userid as this user, and the room id as the id of the room that this user is being added to. If the documents fetched are not null that would mean that this user was in the room from the same account but from some other device so thus we need to delete that document and proceed with adding this one in order to get rid of more than one user room joining from the same account

Aarush-Acharya · 2024-05-24T07:03:20Z

lib/services/room_service.dart

    String myDocId = await addParticipantToAppwriteCollection(
        roomId: appwriteRoomDocId, uid: adminUid, isAdmin: true);
    await joinLiveKitRoom(livekitSocketUrl, livekitToken);

    return [appwriteRoomDocId, myDocId];
  }

+//This method deletes the previously created chat room whose ID is associated with 'roomId'.


Deletes the room with the provided room id, this option is made accessible from the UI to only the admins of the room

Aarush-Acharya · 2024-05-24T07:05:01Z

lib/services/room_service.dart

@@ -126,6 +151,9 @@ class RoomService {
    }
  }

+/* 
+  This method fetches liveKitToken and liveKitSocketUrl,which is necessary to send user to a chat room.


This method fetches liveKitToken and liveKitSocketUrl, which is necessary to join the user into the room, and have it hear the audio being transmitted in the room

Aarush-Acharya · 2024-05-24T07:07:30Z

lib/services/room_service.dart

@@ -137,6 +165,10 @@ class RoomService {
    return myDocId;
  }

+/*
+  This method removes the leaving user's presence from the room,
+  checks if room is now empty, and deletes or updates total-participants accordingly.


deletes the room from collection or updates the total-participants decreasing it by one

Aarush-Acharya · 2024-05-24T07:07:59Z

lib/themes/choose_theme_bottom_sheet.dart

+/*
+  This below Widget function provides a Widget UI, to user 
+  that helps to choos the type of theme system default , light or dark theme.
+ */


correct "choos" to "choose"

Aarush-Acharya · 2024-05-29T10:12:24Z

Hey @Ivan2001otp you there please acknowledge, with a response if we do not receive a response from your side in the next 3 days we would have to close this PR

Aarush-Acharya · 2024-07-16T18:04:55Z

Hey @Ivan2001otp we need a reply from your side as a token of acknowledgement, in order to prove your activeness, we will close the PR if we do not hear from you within the next 3 - 4 days

SarthakPaandey · 2024-08-05T03:18:51Z

@Aarush-Acharya may i work on this if @Ivan2001otp is not responding.

Ivan2001otp added 10 commits February 27, 2024 19:46

added documenation in routes,pages,services files

ed75a0f

added documentation in auth-state-controller

6f82242

added documention in create-room-controller

d68c3c2

documented code in themes/theme_controllers.dart

b782a43

documented code in files of themes -> theme/*

3a0ace9

documented email-verify-controller.dart

8fe557a

documented code in livekit_controller.dart

96f2c21

documented code in controllers/network_controller.dart

b1bdd32

documented onboarding_controller,pair_chat_controller

be881ef

documentation of single_room_controller.dart

2237369

opxdelwin suggested changes Mar 3, 2024

View reviewed changes

vrundraval24 assigned Ivan2001otp May 24, 2024

vrundraval24 added documentation Improvements or additions to documentation attended This PR was attended by a Reviewer awaitIntra labels May 24, 2024

Aarush-Acharya removed the documentation Improvements or additions to documentation label May 24, 2024

Aarush-Acharya reviewed May 25, 2024

View reviewed changes

Ivan2001otp closed this by deleting the head repository Sep 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue - 275 (Meaningful Documentation) #286

Issue - 275 (Meaningful Documentation) #286

Ivan2001otp commented Feb 29, 2024

Ivan2001otp commented Feb 29, 2024

opxdelwin left a comment

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

opxdelwin Mar 3, 2024

Aarush-Acharya May 24, 2024

opxdelwin Mar 3, 2024

Aarush-Acharya commented May 24, 2024 •

edited

Loading

Aarush-Acharya May 23, 2024

Aarush-Acharya May 23, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya May 24, 2024

Aarush-Acharya commented May 29, 2024

Aarush-Acharya commented Jul 16, 2024

SarthakPaandey commented Aug 5, 2024

@@ @@ -119,6 +138,11 @@ class AuthStateController extends GetxController { @@
                   }
                 }
+                /*

@@ @@ -146,12 +170,27 @@ class AuthStateController extends GetxController { @@
                   }
                 }
+                /*

Issue - 275 (Meaningful Documentation) #286

Issue - 275 (Meaningful Documentation) #286

Conversation

Ivan2001otp commented Feb 29, 2024

Description

Type of change

Checklist:

Maintainer Checklist

Ivan2001otp commented Feb 29, 2024

opxdelwin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aarush-Acharya commented May 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aarush-Acharya commented May 29, 2024

Aarush-Acharya commented Jul 16, 2024

SarthakPaandey commented Aug 5, 2024

Aarush-Acharya commented May 24, 2024 •

edited

Loading