improved phpDoc

dg · dg · commit d0c7e3e59426 · 2024-11-28T20:14:30.000+01:00
diff --git a/src/PhpGenerator/Attribute.php b/src/PhpGenerator/Attribute.php
@@ -13,7 +13,7 @@
 
 
 /**
- * PHP Attribute.
+ * Definition of a PHP attribute.
  */
 final class Attribute
 {
diff --git a/src/PhpGenerator/ClassLike.php b/src/PhpGenerator/ClassLike.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Class/Interface/Trait/Enum description.
+ * Base definition of class, interface, trait or enum type.
  */
 abstract class ClassLike
 {
diff --git a/src/PhpGenerator/ClassType.php b/src/PhpGenerator/ClassType.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Class description.
+ * Definition of a class with properties, methods, constants, traits and PHP attributes.
  *
  * @property-deprecated Method[] $methods
  * @property-deprecated Property[] $properties
diff --git a/src/PhpGenerator/Closure.php b/src/PhpGenerator/Closure.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Closure.
+ * Definition of a closure.
  *
  * @property-deprecated string $body
  */
diff --git a/src/PhpGenerator/Constant.php b/src/PhpGenerator/Constant.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Class constant.
+ * Definition of a class constant.
  */
 final class Constant
 {
diff --git a/src/PhpGenerator/EnumCase.php b/src/PhpGenerator/EnumCase.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Enum case.
+ * Definition of an enum case.
  */
 final class EnumCase
 {
diff --git a/src/PhpGenerator/EnumType.php b/src/PhpGenerator/EnumType.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Enum description.
+ * Definition of an enum with cases, methods, constants and traits.
  */
 final class EnumType extends ClassLike
 {
diff --git a/src/PhpGenerator/GlobalFunction.php b/src/PhpGenerator/GlobalFunction.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Global function.
+ * Definition of a global function.
  *
  * @property-deprecated string $body
  */
diff --git a/src/PhpGenerator/InterfaceType.php b/src/PhpGenerator/InterfaceType.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Interface description.
+ * Definition of an interface with methods and constants.
  *
  * @property-deprecated Method[] $methods
  */
diff --git a/src/PhpGenerator/Method.php b/src/PhpGenerator/Method.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Class method.
+ * Definition of a class method.
  *
  * @property-deprecated string|null $body
  */
diff --git a/src/PhpGenerator/Parameter.php b/src/PhpGenerator/Parameter.php
@@ -14,7 +14,7 @@
 
 
 /**
- * Function/Method parameter description.
+ * Definition of a function/method parameter.
  *
  * @property-deprecated mixed $defaultValue
  */
diff --git a/src/PhpGenerator/PhpFile.php b/src/PhpGenerator/PhpFile.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Instance of PHP file.
+ * Definition of a PHP file.
  *
  * Generates:
  * - opening tag (<?php)
diff --git a/src/PhpGenerator/PhpNamespace.php b/src/PhpGenerator/PhpNamespace.php
@@ -14,7 +14,7 @@
 
 
 /**
- * Namespaced part of a PHP file.
+ * Definition of a PHP namespace.
  *
  * Generates:
  * - namespace statement
diff --git a/src/PhpGenerator/PromotedParameter.php b/src/PhpGenerator/PromotedParameter.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Promoted parameter in constructor.
+ * Definition of a promoted constructor parameter.
  */
 final class PromotedParameter extends Parameter
 {
diff --git a/src/PhpGenerator/Property.php b/src/PhpGenerator/Property.php
@@ -14,7 +14,7 @@
 
 
 /**
- * Class property description.
+ * Definition of a class property.
  *
  * @property-deprecated mixed $value
  */
diff --git a/src/PhpGenerator/TraitType.php b/src/PhpGenerator/TraitType.php
@@ -13,7 +13,7 @@
 
 
 /**
- * Trait description.
+ * Definition of a trait with properties, methods, constants and traits.
  *
  * @property-deprecated Method[] $methods
  * @property-deprecated Property[] $properties
diff --git a/src/PhpGenerator/TraitUse.php b/src/PhpGenerator/TraitUse.php
@@ -13,7 +13,7 @@
 
 
 /**
- * use Trait
+ * Definition of a trait use statement.
  */
 final class TraitUse
 {

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`
`15`	`15`	`/**`
`16`		`- * PHP Attribute.`
	`16`	`+ * Definition of a PHP attribute.`
`17`	`17`	`*/`
`18`	`18`	`final class Attribute`
`19`	`19`	`{`