added comments

updated changelog
getsentry · stefanosiano · Jun 17, 2025 · Mar 14, 2025 · Mar 25, 2025 · Mar 25, 2025
commit 62cea5eb79c7a50faf0579aa49ccb7a38bd6eb6a
@@ -6,44 +6,17 @@
 
 - Add New User Feedback form ([#4384](https://github.com/getsentry/sentry-java/pull/4384))
     - We now introduce SentryUserFeedbackDialog, which extends AlertDialog, inheriting the show() and cancel() methods, among others.
-      - The dialog integrates with the current dialog theme, so it's compatible with dark mode, and can be customized with a custom xml style.
-        - ```styles.xml or themes.xml
-          <!-- Application theme. -->
-          <style name="MyAppTheme" parent="Theme.AppCompat.DayNight.DarkActionBar">
-            ...
-            current theme customizations
-            ...
-            <!-- Set a dialog theme if not already done. -->
-            <item name="android:dialogTheme">@style/MyAppDialogTheme</item>
-          </style>
-
-          <!-- Edit application dialog theme. -->
-          <style name="MyAppDialogTheme" parent="Theme.AppCompat.DayNight.Dialog">
-            <!-- Set the style of the feedback dialog title. -->
-            <item name="android:windowTitleStyle">@style/FeedbackFormTitleStyle</item>
-
-            <!-- Set the color of title, cancel button text, and non editable texts. -->
-            <item name="android:textColor">@color/colorPrimary</item>
-            <!-- Set the color of editable texts. -->
-            <item name="android:editTextColor">@color/colorPrimaryDark</item>
-            <!-- Set the color of the hint of editable texts. -->
-            <item name="android:textColorHint">@color/colorPrimaryDark</item>
-            <!-- Set the color of the send button text. -->
-            <item name="android:textColorPrimaryInverse">@android:color/white</item>
-
-            <!-- Set the background color of the send button. -->
-            <item name="android:colorPrimary">@color/colorPrimary</item>
-            <!-- Set the background color of the cancel button. -->
-            <item name="android:colorBackground">@android:color/black</item>
-            <!-- Set the color tint of the image logo. -->
-            <item name="android:colorForeground">@color/colorPrimary</item>
-          </style>
-
-          <style name="FeedbackFormTitleStyle">
-            <!-- Customize your theme here. -->
-            <item name="android:textAppearance">@style/TextAppearance.AppCompat.Title</item>
-          </style>
-        ```
+      To use it, just instantiate it and call show() on the instance (Sentry must be previously initialized).
+      ```java
+      import io.sentry.android.core.SentryUserFeedbackDialog;
+
+      new SentryUserFeedbackDialog(context).show();
+      ```
+      ```kotlin
+      import io.sentry.android.core.SentryUserFeedbackDialog
+
+      SentryUserFeedbackDialog(context).show()
+      ```
 
 ## 8.12.0
 

@@ -73,6 +73,7 @@ protected void onCreate(Bundle savedInstanceState) {
       imgLogo.setVisibility(View.GONE);
     }
 
+    // If name is required, ignore showName flag
     if (!feedbackOptions.isShowName() && !feedbackOptions.isNameRequired()) {
       lblName.setVisibility(View.GONE);
       edtName.setVisibility(View.GONE);
@@ -86,6 +87,7 @@ protected void onCreate(Bundle savedInstanceState) {
       }
     }
 
+    // If email is required, ignore showEmail flag
     if (!feedbackOptions.isShowEmail() && !feedbackOptions.isEmailRequired()) {
       lblEmail.setVisibility(View.GONE);
       edtEmail.setVisibility(View.GONE);
@@ -99,6 +101,7 @@ protected void onCreate(Bundle savedInstanceState) {
       }
     }
 
+    // If Sentry user is set, and useSentryUser is true, populate the name and email
     if (feedbackOptions.isUseSentryUser()) {
       final @Nullable User user = Sentry.getCurrentScopes().getScope().getUser();
       if (user != null) {
@@ -115,11 +118,12 @@ protected void onCreate(Bundle savedInstanceState) {
     btnSend.setText(feedbackOptions.getSubmitButtonLabel());
     btnSend.setOnClickListener(
         v -> {
+          // Gather fields and trim them
           final @NotNull String name = edtName.getText().toString().trim();
           final @NotNull String email = edtEmail.getText().toString().trim();
           final @NotNull String message = edtMessage.getText().toString().trim();
-          final @NotNull Feedback feedback = new Feedback(message);
 
+          // If a required field is missing, shows the error label
           if (name.isEmpty() && feedbackOptions.isNameRequired()) {
             edtName.setError(lblName.getText());
             return;
@@ -135,10 +139,13 @@ protected void onCreate(Bundle savedInstanceState) {
             return;
           }
 
+          // Create the feedback object
+          final @NotNull Feedback feedback = new Feedback(message);
           feedback.setName(name);
           feedback.setContactEmail(email);
 
-          SentryId id = Sentry.captureFeedback(feedback);
+          // Capture the feedback. If the ID is empty, it means that the feedback was not sent
+          final @NotNull SentryId id = Sentry.captureFeedback(feedback);
           if (!id.equals(SentryId.EMPTY_ID)) {
             Toast.makeText(
                     getContext(), feedbackOptions.getSuccessMessageText(), Toast.LENGTH_SHORT)
@@ -180,6 +187,7 @@ protected void onStart() {
 
   @Override
   public void show() {
+    // If Sentry is disabled, don't show the dialog, but log a warning
     final @NotNull IScopes scopes = Sentry.getCurrentScopes();
     final @NotNull SentryOptions options = scopes.getOptions();
     if (!scopes.isEnabled() || !options.isEnabled()) {
@@ -188,6 +196,7 @@ public void show() {
           .log(SentryLevel.WARNING, "Sentry is disabled. Feedback dialog won't be shown.");
       return;
     }
+    // Otherwise, show the dialog
     super.show();
   }
 }