Add content to README files and explain naming in more details as well as the tasks

Author: tobiasso85

src/reporter/README.md

@@ -3,7 +3,7 @@
 This package contains the reporting mechanism.
 The reporting mechanism is used to:
 * collect Information about migration entries (findings)
-* create a report at the end of a migration/analysis, e.g. to dump it to the console
+* create a report at the end of a migration (analysis), e.g. as console dump
 
 # Contents
 

src/tasks/README.md

@@ -1,15 +1,42 @@
 # About
 
 This package contains tasks.
-A task is a procedure which can be executed by the migration tooling and operates on the contents of a source file.
+A task is a procedure which can be executed by the migration tooling and operates on the contents of
+a source file.
 The content is parsed into an AST and passed to the task.
-It is used to:
-* `analyze`: checks the AST and gathers findings and creates an analysis
+It performs the following tasks in order:
+* `analyze`: checks the AST, gathers findings and creates an analysis
 * `migrate`: works on the analysis of the AST and modifies it
 
 # Contents
 
 It contains Task classes implementing the `Task` interface.
+* `addMissingDependencies`: find in the ast code usage where the dependency is missing from the
+`sap.ui.define`/`sap.ui.require` dependencies array. Very dynamic approach based on configuration
+  of:
+  * `finders` (scans the AST and looks for findings)
+  * `replacers` (modifies the AST for a given finding)
+  * `extenders` (manages the dependencies in the `sap.ui.define`/`sap.ui.require` call)
+  
+  Is used when the replacement is more complex and not a straight forward way,
+  e.g. such as a renaming or a simple global-call with module call replacement.
+* `addRenderers`: checks controls and adds a missing Renderer dependency if required.
+  Is limited to controls and their renderers
+* `amdCleanup`: checks the AMD syntax and if none found wraps all code inside a new sap.ui.define
+  call. Runs in the beginning before all other tasks (high priority), because the AMD syntax is
+  required for the dependency handling.
+* `fixTypeDependency`: Scans the code for the usage of types, which are defined in the library and
+  adds a dependency to the library and references the type.
+* `replaceGlobals`: Scans the code for global function calls, e.g. `jQuery.sap.log(...)` and
+  replaces these by a module call.
+  It handles the dependency and is semi-flexible, which means the dependency handling is static and
+  the replacements are typical module replacements, but also more complex replacements can be
+  performed.
+* `variableNamePrettifier`: Scans the newly introduced variables (from dependencies) and cleans them
+  up, if there were naming conflicts variable names are made unique by appending a number,
+  e.g. `jQuery` and `jQuery0` and when after all tasks were run `jQuery0` remains solely,
+  this task will replace it with `jQuery`.
+  It runs after all other tasks (low priority).
 
 ## Naming convention
 

src/util/file/README.md

@@ -9,6 +9,6 @@ It aims to abstract and simplify file handling.
 
 ## Naming convention
 
+Filter - are used to reduce the elements in a given array. In this package the filters are used to
+reduce a set of filesystem files.
 
-
-## SubFolders

src/util/whitespace/README.md

@@ -3,14 +3,17 @@
 This package contains whitespace classes and functionality.
 It aims to reduce the whitespace noise between 2 strings.
 Whitespace noise includes changes of whitespace characters.
-Whitespace characters are TAB, SPACE and NEWLINE.
+Whitespace characters are e.g. TAB, SPACE and NEWLINE.
 
 
 # Contents
 
 
 ## Naming convention
 
+Strategy - represents an interchangeable way of performing a task. In this folder various strategies
+for handling whitespace differences were implemented.
+
 
 
 ## SubFolders