Clean up comments

Author: wenli-cai

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/App.kt

@@ -68,7 +68,7 @@ public fun App(
 
     // The states are reset when a new file is selected.
     UploadFile(
-      onFileSelect = {
+      resetOnFileSelect = {
         selectedTraceFile = it
         selectedNode = null
         frameIndex = 0

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/ui/WorkflowInfoPanel.kt

@@ -40,7 +40,6 @@ internal fun RightInfoPanel(
   selectedNode: Node?,
   modifier: Modifier = Modifier
 ) {
-  // This row is aligned to the right of the screen.
   Row(
     modifier = modifier
   ) {

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/ui/WorkflowTree.kt

@@ -67,7 +67,6 @@ internal fun RenderDiagram(
   }
 
   if (!isLoading) {
-    // DrawTree(frames[frameInd], affectedNodes[frameInd], onNodeSelect)
     DrawTree(fullTree[frameInd], affectedNodes[frameInd], onNodeSelect)
   }
 }

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/util/JsonParser.kt

@@ -30,7 +30,7 @@ internal suspend fun parseTrace(
   val workflowAdapter = createMoshiAdapter()
   val parsedRenderPasses = try {
     workflowAdapter.fromJson(jsonString) ?: return ParseResult.Failure(
-      IllegalArgumentException("The provided file does not contain a valid trace.")
+      IllegalArgumentException("Provided trace file is empty or malformed.")
     )
     /*
       this parsing method can never be called without a provided file, so we can assume that there
@@ -94,8 +94,11 @@ private fun buildTree(node: Node, childrenByParent: Map<String, List<Node>>): No
 }
 
 /**
- * Every new frame starts with the same roots as the main tree, so we can do a simple traversal to
- * add any missing child nodes from the frame.
+ * Every new frame starts with the same roots as the main tree, so we can fold each frame into the
+ * current tree, add all the missing children or replace any new ones, and then store the newly
+ * merged tree.
+ *
+ * @return Node the newly formed tree with the frame merged into it.
  */
 internal fun mergeFrameIntoMainTree(
   frame: Node,

workflow-trace-viewer/src/jvmMain/kotlin/com/squareup/workflow1/traceviewer/util/UploadFile.kt

@@ -20,14 +20,14 @@ import io.github.vinceglb.filekit.dialogs.compose.rememberFilePickerLauncher
  */
 @Composable
 public fun UploadFile(
-  onFileSelect: (PlatformFile?) -> Unit,
+  resetOnFileSelect: (PlatformFile?) -> Unit,
   modifier: Modifier = Modifier,
 ) {
   val launcher = rememberFilePickerLauncher(
     type = FileKitType.File(listOf("json", "txt")),
     title = "Select Workflow Trace File"
   ) {
-    onFileSelect(it)
+    resetOnFileSelect(it)
   }
 
   Button(