add comments

Author: SBOne-Kenobi

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/InvocationContext.kt

@@ -13,6 +13,9 @@ class InvocationPhaseError(cause: Throwable) : PhaseError(
     cause
 )
 
+/**
+ * This phase is about invoking user's code using [delegateInstrumentation].
+ */
 class InvocationContext(
     private val delegateInstrumentation: Instrumentation<Result<*>>
 ) : PhaseContext<InvocationPhaseError> {

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/ModelConstructionContext.kt

@@ -29,6 +29,9 @@ class ModelConstructionPhaseError(cause: Throwable) : PhaseError(
     cause
 )
 
+/**
+ * This phase of model construction from concrete values.
+ */
 class ModelConstructionContext(
     private val traceHandler: TraceHandler
 ) : PhaseContext<ModelConstructionPhaseError> {

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/PhaseContext.kt

@@ -1,9 +1,6 @@
 package org.utbot.framework.concrete.phases
 
-abstract class PhaseError(message: String, cause: Throwable) : Exception(message, cause) {
-    override val cause: Throwable = super.cause!!
-}
-
+abstract class PhaseError(message: String, override val cause: Throwable) : Exception(message)
 interface PhaseContext<E: PhaseError> {
     fun wrapError(error: Throwable): E
 }

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/PostprocessingContext.kt

@@ -9,6 +9,9 @@ class PostprocessingPhaseError(cause: Throwable) : PhaseError(
     cause
 )
 
+/**
+ * The responsibility of this phase is resetting environment to the initial state.
+ */
 class PostprocessingContext : PhaseContext<PostprocessingPhaseError> {
 
     override fun wrapError(error: Throwable): PostprocessingPhaseError =

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/PreparationContext.kt

@@ -11,6 +11,9 @@ class PreparationPhaseError(cause: Throwable) : PhaseError(
     cause
 )
 
+/**
+ * The responsibility of this phase is environment preparation before execution.
+ */
 class PreparationContext(
     private val traceHandler: TraceHandler
 ) : PhaseContext<PreparationPhaseError> {

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/StatisticsCollectionContext.kt

@@ -11,6 +11,9 @@ class StatisticsCollectionPhaseError(cause: Throwable) : PhaseError(
     cause
 )
 
+/**
+ * This phase is about collection statistics such as coverage.
+ */
 class StatisticsCollectionContext(
     private val traceHandler: TraceHandler
 ) : PhaseContext<StatisticsCollectionPhaseError> {

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/phases/ValueConstructionContext.kt

@@ -18,6 +18,9 @@ class ValueConstructionPhaseError(cause: Throwable) : PhaseError(
     cause
 )
 
+/**
+ * This phase of values instantiation from given models.
+ */
 class ValueConstructionContext(
     instrumentationContext: InstrumentationContext
 ) : PhaseContext<ValueConstructionPhaseError>, Closeable {