Added php-doc comments and todos

Author: WalterWoshid

src/Core/Cache/CacheState/EmptyResultCacheState.php

@@ -5,7 +5,14 @@
 use Okapi\CodeTransformer\Core\Cache\CacheState;
 
 /**
- * TODO: docs
+ * # Empty Result Cache State
+ *
+ * This class is used to represent an empty result cache state, which means that
+ * the class was not matched by any transformer.
+ *
+ * @todo: I think when a transformer is changed, the cache state should be
+ *   invalidated. This is not currently the case. Maybe clear the whole cache
+ *   when a transformer is changed?
  */
 class EmptyResultCacheState extends CacheState
 {

src/Core/Cache/CacheState/NoTransformationsCacheState.php

@@ -4,7 +4,13 @@
 
 use Okapi\CodeTransformer\Core\Cache\CacheState;
 
-// TODO: docs
+/**
+ * # No Transformations Cache State
+ *
+ * This class is used to represent a no transformations cache state, which
+ * means that the file was matched by the transformers, but no transformations
+ * were applied.
+ */
 class NoTransformationsCacheState extends CacheState
 {
     /**

src/Core/Cache/CacheState/TransformedCacheState.php

@@ -2,10 +2,13 @@
 
 namespace Okapi\CodeTransformer\Core\Cache\CacheState;
 
-
 use Okapi\CodeTransformer\Core\Cache\CacheState;
 
-// TODO: docs
+/**
+ * # Transformed Cache State
+ *
+ * This class is used to store the cache state for transformed files.
+ */
 class TransformedCacheState extends CacheState
 {
 

src/Core/Cache/CacheStateFactory.php

@@ -2,14 +2,17 @@
 
 namespace Okapi\CodeTransformer\Core\Cache;
 
-
 use Okapi\CodeTransformer\Core\Cache\CacheState\EmptyResultCacheState;
 use Okapi\CodeTransformer\Core\Cache\CacheState\NoTransformationsCacheState;
 use Okapi\CodeTransformer\Core\Cache\CacheState\TransformedCacheState;
 use Okapi\CodeTransformer\Core\DI;
 use TypeError;
 
-// TODO: docs
+/**
+ * # Cache State Factory
+ *
+ * This class is used to create cache states from the cache state file.
+ */
 class CacheStateFactory
 {
     /**

src/Core/Container/TransformerContainer.php

@@ -4,7 +4,11 @@
 
 use Okapi\CodeTransformer\Transformer;
 
-// TODO: docs
+/**
+ * # Transformer Container
+ *
+ * This class is used to store the transformer instances.
+ */
 class TransformerContainer
 {
     /**

src/Core/Container/TransformerManager.php

@@ -14,15 +14,13 @@
  * # Transformer Manager
  *
  * This class is used to register and manage the transformers.
- * @todo Don't repeat class name in docs
  */
 class TransformerManager implements ServiceInterface
 {
     /**
      * The list of transformer class strings.
      *
      * @var class-string<Transformer>[]
-     * @todo CHECK if all class-string have a type
      */
     private array $transformers = [];
 

src/Core/Matcher/TransformerMatcher.php

@@ -11,7 +11,11 @@
 use Okapi\CodeTransformer\Transformer;
 use Okapi\Wildcards\Regex;
 
-// TODO: docs
+/**
+ * # Transformer Matcher
+ *
+ * This class is used to match the transformers to the classes.
+ */
 class TransformerMatcher
 {
     // region DI