ISSUE-646: Docs

KasperskyLab · Aug 29, 2024 · 02c9c81 · 02c9c81
1 parent 15d0185
commit 02c9c81
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/...ain/java/com/kaspersky/components/composesupport/flakysafety/ComposeFlakySafetyScalper.kt b/...ain/java/com/kaspersky/components/composesupport/flakysafety/ComposeFlakySafetyScalper.kt
@@ -6,6 +6,10 @@ import com.kaspersky.components.composesupport.interceptors.behavior.impl.flakys
 import com.kaspersky.components.composesupport.interceptors.watcher.SemanticsWatcherInterceptor
 import com.kaspersky.kaspresso.flakysafety.scalpel.external.ExternalFlakySafetyScalper
 
+/**
+ * Removes and restores compose flaky safety interceptor so the `flakySafely` expression works correctly
+ * @see com.kaspersky.kaspresso.flakysafety.scalpel.FlakySafeInterceptorScalpel
+ */
 class ComposeFlakySafetyScalper(
     private val semanticsBehaviorInterceptors: MutableList<SemanticsBehaviorInterceptor>,
     private val semanticsWatcherInterceptors: MutableList<SemanticsWatcherInterceptor>,

diff --git a/...rc/main/kotlin/com/kaspersky/kaspresso/flakysafety/scalpel/FlakySafeInterceptorScalpel.kt b/...rc/main/kotlin/com/kaspersky/kaspresso/flakysafety/scalpel/FlakySafeInterceptorScalpel.kt
@@ -14,7 +14,7 @@ import com.kaspersky.kaspresso.interceptors.tolibrary.KakaoLibraryInjector
 import com.kaspersky.kaspresso.kaspresso.Kaspresso
 
 /**
- * The special class that removes all interceptors related to FlakySafety from Kautomator settings
+ * The special class that removes all interceptors related to FlakySafety from kakao settings
  * and restore them by demand
  */
 internal class FlakySafeInterceptorScalpel(

diff --git a/kaspresso/src/main/kotlin/com/kaspersky/kaspresso/kaspresso/Kaspresso.kt b/kaspresso/src/main/kotlin/com/kaspersky/kaspresso/kaspresso/Kaspresso.kt
@@ -653,6 +653,11 @@ data class Kaspresso(
          */
         lateinit var testRunWatcherInterceptors: MutableList<TestRunWatcherInterceptor>
 
+        /**
+         * Holds a reference to the custom "external" flaky safety scalpers that are not set in the kaspresso by default
+         * @see com.kaspersky.kaspresso.flakysafety.scalpel.FlakySafeInterceptorScalpel
+         * @see com.kaspersky.kaspresso.flakysafety.scalpel.external.ExternalFlakySafetyScalper
+         */
         lateinit var externalFlakySafetyScalperNotifier: ExternalFlakySafetyScalperNotifier
 
         /**