Preserve comments from annotations

php-static-analysis · Feb 21, 2024 · 1a546ac · 1a546ac
1 parent a9e5db4
commit 1a546ac
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 12 deletions.
diff --git a/composer.json b/composer.json
@@ -26,8 +26,8 @@
     "require": {
         "php": ">=8.0",
         "ext-simplexml": "*",
-        "php-static-analysis/attributes": "^0.1.6 || dev-main",
-        "php-static-analysis/node-visitor": "^0.1.6 || dev-main",
+        "php-static-analysis/attributes": "^0.1.7 || dev-main",
+        "php-static-analysis/node-visitor": "^0.1.7 || dev-main",
         "vimeo/psalm": "^5"
     },
     "require-dev": {

diff --git a/tests/data/IsReadOnly/PropertyIsReadOnlyAttribute.php b/tests/data/IsReadOnly/PropertyIsReadOnlyAttribute.php
@@ -6,7 +6,7 @@
 
 class PropertyIsReadOnlyAttribute
 {
-    #[IsReadOnly]
+    #[IsReadOnly] // cannot be written to
     public string $name;
 
     public function __construct()

diff --git a/tests/data/Method/ClassMethodAttribute.php b/tests/data/Method/ClassMethodAttribute.php
@@ -5,7 +5,7 @@
 use PhpStaticAnalysis\Attributes\Method;
 use PhpStaticAnalysis\Attributes\Param;
 
-#[Method('string getString()')]
+#[Method('string getString()')] // get the main string
 #[Method(
     'void setString(string $text)',
     'static string staticGetter()',

diff --git a/tests/data/Param/MethodParamAttribute.php b/tests/data/Param/MethodParamAttribute.php
@@ -6,7 +6,7 @@
 
 class MethodParamAttribute
 {
-    #[Param(names: 'string[]')]
+    #[Param(names: 'string[]')] // returns the number of names
     public function countNames($names): int
     {
         return count($names);

diff --git a/tests/data/Property/ClassPropertyAttribute.php b/tests/data/Property/ClassPropertyAttribute.php
@@ -4,7 +4,7 @@
 
 use PhpStaticAnalysis\Attributes\Property;
 
-#[Property(name: 'string')]
+#[Property(name: 'string')] // the name of the user
 #[Property('int $age')]
 #[Property(
     index1: 'string[]',

diff --git a/tests/data/PropertyRead/ClassPropertyReadAttribute.php b/tests/data/PropertyRead/ClassPropertyReadAttribute.php
@@ -4,7 +4,7 @@
 
 use PhpStaticAnalysis\Attributes\PropertyRead;
 
-#[PropertyRead(name: 'string')]
+#[PropertyRead(name: 'string')] // cannot be written to
 #[PropertyRead('int $age')]
 #[PropertyRead(
     index1: 'string[]',

diff --git a/tests/data/PropertyWrite/ClassPropertyWriteAttribute.php b/tests/data/PropertyWrite/ClassPropertyWriteAttribute.php
@@ -4,7 +4,7 @@
 
 use PhpStaticAnalysis\Attributes\PropertyWrite;
 
-#[PropertyWrite(name: 'string')]
+#[PropertyWrite(name: 'string')] // cannot be read
 #[PropertyWrite('int $age')]
 #[PropertyWrite(
     index1: 'string[]',

diff --git a/tests/data/Returns/MethodReturnsAttribute.php b/tests/data/Returns/MethodReturnsAttribute.php
@@ -6,7 +6,7 @@
 
 class MethodReturnsAttribute
 {
-    #[Returns('string[]')]
+    #[Returns('string[]')] // the names of the users
     public function getNames(): array
     {
         return ['hello', 'world'];

diff --git a/tests/data/Template/ClassTemplateAttribute.php b/tests/data/Template/ClassTemplateAttribute.php
@@ -6,7 +6,7 @@
 use PhpStaticAnalysis\Attributes\Returns;
 use PhpStaticAnalysis\Attributes\Template;
 
-#[Template('T')]
+#[Template('T')] // the type used in the class
 class ClassTemplateAttribute
 {
     #[Param(param: 'T')]

diff --git a/tests/data/TemplateCovariant/ClassTemplateCovariantAttribute.php b/tests/data/TemplateCovariant/ClassTemplateCovariantAttribute.php
@@ -16,7 +16,7 @@ class ClassTemplateCovariantAttributeChild extends ClassTemplateCovariantAttribu
     public function getName() : string { return "child"; }
 }
 
-#[TemplateCovariant('T')]
+#[TemplateCovariant('T')] // can only be used in covariant position
 class Collection {
     #[Type('array<int, T>')]
     public array $list = [];

diff --git a/tests/data/Type/PropertyTypeAttribute.php b/tests/data/Type/PropertyTypeAttribute.php
@@ -9,7 +9,7 @@ class PropertyTypeAttribute
     #[Type('string')]
     public const ATTRIBUTE_NAME = 'Type';
 
-    #[Type('int[]')]
+    #[Type('int[]')] // number of items
     public array $nums = [];
 
     /**