better docs

Author: jrushlow

src/Util/ClassNameDetails.php

@@ -55,6 +55,12 @@ public function getRelativeNameWithoutSuffix(): string
         return Str::removeSuffix($this->getRelativeName(), $this->suffix);
     }
 
+    /**
+     * Returns the Short Name of the class with the substitute prefix.
+     *
+     * E.g. \Doctrine\ORM\Mapping\Column::class and the substitutePrefix = ORM,
+     * the ORM\Column will be returned.
+     */
     public function getShortNameWithSubstitutePrefix(): string
     {
         return sprintf('%s\\%s', $this->substitutePrefix, $this->getShortName());

src/Util/ClassSourceManipulator.php

@@ -352,10 +352,6 @@ public function addProperty(string $name, array $annotationLines = [], $defaultV
 
         $newPropertyBuilder = (new Builder\Property($name))->makePrivate();
 
-//        if ($annotationLines && $this->useAnnotations) {
-//            $newPropertyBuilder->setDocComment($this->createDocBlock($annotationLines));
-//        }
-
         if ($this->useAttributesForDoctrineMapping) {
             foreach ($attributes as $attribute) {
                 $newPropertyBuilder->addAttribute($attribute);
@@ -929,6 +925,31 @@ public function addUseStatementIfNecessary(string $class): string
         return $shortClassName;
     }
 
+    /**
+     * Builds a PHPParser attribute node.
+     *
+     * @param ClassNameDetails $attributeClass The attribute class which should be used for the attribute. If the class has a substitute
+     *                                         prefix, the node is built using the prefix. E.g. #[ORM\Column()] Otherwise, the
+     *                                         short name is used. E.g. #[Column()]
+     * @param array            $options        the named arguments for the attribute ($key = argument name, $value = argument value)
+     */
+    public function buildAttributeNode(ClassNameDetails $attributeClass, array $options): Node\Attribute
+    {
+        $options = $this->sortOptionsByClassConstructorParameters($options, $attributeClass->getFullName());
+
+        $context = $this;
+        $nodeArguments = array_map(static function ($option, $value) use ($context) {
+            return new Node\Arg($context->buildNodeExprByValue($value), false, false, [], new Node\Identifier($option));
+        }, array_keys($options), array_values($options));
+
+        $class = $attributeClass->hasSubstitutePrefix() ? $attributeClass->getShortNameWithSubstitutePrefix() : $attributeClass->getShortName();
+
+        return new Node\Attribute(
+            new Node\Name($class),
+            $nodeArguments
+        );
+    }
+
     private function updateSourceCodeFromNewStmts(): void
     {
         $newCode = $this->printer->printFormatPreserving(
@@ -1450,29 +1471,6 @@ private function buildNodeExprByValue($value): Node\Expr
         return $nodeValue;
     }
 
-    /**
-     * builds an PHPParser attribute node.
-     *
-     * @param ClassNameDetails $attributeClass the attribute class which should be used for the attribute
-     * @param array            $options        the named arguments for the attribute ($key = argument name, $value = argument value)
-     */
-    public function buildAttributeNode(ClassNameDetails $attributeClass, array $options): Node\Attribute
-    {
-        $options = $this->sortOptionsByClassConstructorParameters($options, $attributeClass->getFullName());
-
-        $context = $this;
-        $nodeArguments = array_map(static function ($option, $value) use ($context) {
-            return new Node\Arg($context->buildNodeExprByValue($value), false, false, [], new Node\Identifier($option));
-        }, array_keys($options), array_values($options));
-
-        $class = $attributeClass->hasSubstitutePrefix() ? $attributeClass->getShortNameWithSubstitutePrefix() : $attributeClass->getShortName();
-
-        return new Node\Attribute(
-            new Node\Name($class),
-            $nodeArguments
-        );
-    }
-
     /**
      * sort the given options based on the constructor parameters for the given $classString
      * this prevents code inspections warnings for IDEs like intellij/phpstorm.