Revert "refactor(analysis): replace TODO comments with descriptive notes"

This reverts commit 8fbb9de.

Author: christian-huehn-mw

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/converter/ProjectConverter.kt

@@ -30,7 +30,7 @@ class ProjectConverter(private val containsAuthors: Boolean) {
         edges.forEach {
             projectBuilder.insertEdge(addRootToEdgePaths(it))
         }
-        // Note: memory utilization could be improved by injecting metrics for calculations
+        // TODO improve memory utilization -> inject metrics for calculations
         // instead of creating a hard reference in VersionControlledFile
         versionControlledFile.removeMetricsToFreeMemory()
     }
@@ -56,7 +56,8 @@ class ProjectConverter(private val containsAuthors: Boolean) {
 
         val versionControlledFilesInGitProject = VersionControlledFilesInGitProject(vcFList, filesInLog)
 
-        versionControlledFilesInGitProject.getListOfVCFilesMatchingGitProject().forEach { vcFile ->
+        versionControlledFilesInGitProject.getListOfVCFilesMatchingGitProject().forEach { // TODO Coroutines?
+            vcFile ->
             addVersionControlledFile(projectBuilder, vcFile)
         }
 

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/parser/StandardCommitParser.kt

@@ -55,7 +55,7 @@ class StandardCommitParser : CommitParser {
     }
 
     private fun handleDeleteModification(versionControlledFilesList: VersionControlledFilesList, trackName: String) {
-        // Note: registerCommit() may be needed to track deleted and then reverted files as author and commit amount
+        // TODO registerCommit() needed? @Ruben do we want to track deleted and then reverted files as author and commit amount
         // In some cases a file which is deleted by a modification is not present
         // This would cause a NullPointerException
         // We do a safe call to prevent the Parser from crashing (for now).
@@ -82,7 +82,7 @@ class StandardCommitParser : CommitParser {
         trackName: String,
         commit: Commit,
         mod: Modification
-    ) { // Note: consider registering delete commits if a RENAME OR MODIFY commit follows
+    ) { // TODO Do we have to register delete commits if a RENAME OR MODIFY commit follows? (refer line 33)
 
         var file = versionControlledFilesList.get(trackName)
         if (file == null) {

analysis/analysers/parsers/GitLogParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/gitlog/parser/VersionControlledFilesInGitProject.kt

@@ -6,7 +6,7 @@ class VersionControlledFilesInGitProject(
     private val vcFList: MutableMap<String, VersionControlledFile>,
     private val filesInGitLog: List<String>
 ) {
-    // Note: salts should not be part of filenames, consider changing this logic
+    // TODO salts should not be part of filenames, change logic error
     private fun removeSaltFromFilenames() {
         vcFList.values.forEach {
             it.filename = it.filename.substringBefore("_\\0_")

analysis/analysers/parsers/RawTextParser/src/main/kotlin/de/maibornwolff/codecharta/analysers/parsers/rawtext/metrics/IndentationMetric.kt

@@ -12,7 +12,7 @@ class IndentationMetric(private var maxIndentation: Int, private var verbose: Bo
         const val NAME = "IndentationLevel"
     }
 
-    // Note: mixed tab/space indentation at line start is not currently handled
+    // TODO no mixed tab/ space possible at line start?
     override fun parseLine(line: String) {
         var tabIndent = line.length - line.trimStart('\t').length
         var spaceIndent = line.length - line.trimStart(' ').length
@@ -27,7 +27,7 @@ class IndentationMetric(private var maxIndentation: Int, private var verbose: Bo
         }
     }
 
-    // Note: could use tabSize - (offset % tabSize) from the current position for more accuracy
+    // TODO tabSize - (offset % tabSize) from the current position
     private fun guessTabWidth(): Int {
         tabWidth = 1
         if (spaceIndentations.sum() == 0) return tabWidth