From ab8444e667d8bb8d5f0ad1486d9a84ef28180972 Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Tue, 27 Jun 2023 19:48:00 +0200 Subject: [PATCH] Fixes --- src/PhpDoc/ClassDoc.php | 43 +++++++++++++++++++++++++++++++--------- src/PhpDoc/MethodDoc.php | 4 ++-- 2 files changed, 36 insertions(+), 11 deletions(-) diff --git a/src/PhpDoc/ClassDoc.php b/src/PhpDoc/ClassDoc.php index b0bdd8c..e45232d 100644 --- a/src/PhpDoc/ClassDoc.php +++ b/src/PhpDoc/ClassDoc.php @@ -6,9 +6,11 @@ use danog\PhpDoc\PhpDoc; use phpDocumentor\Reflection\DocBlock\Tags\Generic; use phpDocumentor\Reflection\DocBlock\Tags\InvalidTag; use phpDocumentor\Reflection\DocBlock\Tags\Property; +use phpDocumentor\Reflection\DocBlock\Tags\Var_; use ReflectionClass; use ReflectionClassConstant; use ReflectionMethod; +use ReflectionProperty; /** * Class documentation builder. @@ -47,7 +49,30 @@ class ClassDoc extends GenericDoc parent::__construct($doc, $reflectionClass); - $tags = $doc->getTags(); + $docReflection = "/**\n"; + foreach ($reflectionClass->getProperties(ReflectionProperty::IS_PUBLIC & ~ReflectionProperty::IS_STATIC) as $property) { + $type = $property->getType()?->getName() ?? 'mixed'; + $name = $property->getName(); + $comment = ''; + foreach ($this->builder->getFactory()->create($property->getDocComment() ?: '/** */')->getTags() as $tag) { + if ($tag instanceof Var_) { + $comment = $tag->getDescription(); + $type = $tag->getType() ?? 'mixed'; + break; + } + if ($tag instanceof Generic && $tag->getName() === 'internal') { + continue 2; + } + } + if (!$comment) { + $comment = trim($property->getDocComment() ?: '', "\n/* "); + } + $docReflection .= " * @property $type \$$name $comment\n"; + } + $docReflection .= " */\n"; + $docReflection = $this->builder->getFactory()->create($docReflection); + + $tags = array_merge($docReflection->getTags(), $doc->getTags()); foreach ($tags as $tag) { if ($tag instanceof Property && $tag->getVariableName()) { /** @psalm-suppress InvalidPropertyAssignmentValue */ @@ -100,7 +125,7 @@ class ClassDoc extends GenericDoc foreach ($reflectionClass->getMethods(ReflectionMethod::IS_PUBLIC) as $method) { - if (\str_starts_with($method->getName(), '__') && $method !== '__construct') { + if (\str_starts_with($method->getName(), '__') && $method->getName() !== '__construct') { continue; } $this->methods[$method->getName()] = new MethodDoc($this->builder, $method); @@ -127,6 +152,13 @@ class ClassDoc extends GenericDoc $init .= "\n"; } } + if ($this->properties) { + $init .= "## Properties\n"; + foreach ($this->properties as $name => [$type, $description]) { + $init .= "* `\$$name`: `$type` $description"; + $init .= "\n"; + } + } if ($this->methods) { $init .= "\n"; $init .= "## Method list:\n"; @@ -140,13 +172,6 @@ class ClassDoc extends GenericDoc $init .= "\n"; } } - if ($this->properties) { - $init .= "## Properties\n"; - foreach ($this->properties as $name => [$type, $description]) { - $init .= "* `\$$name`: `$type` $description"; - $init .= "\n"; - } - } $init .= "---\n"; $init .= "Generated by [danog/phpdoc](https://phpdoc.daniil.it)\n"; return $init; diff --git a/src/PhpDoc/MethodDoc.php b/src/PhpDoc/MethodDoc.php index e0770db..d2435ef 100644 --- a/src/PhpDoc/MethodDoc.php +++ b/src/PhpDoc/MethodDoc.php @@ -67,7 +67,7 @@ class MethodDoc extends GenericDoc $tag->getDescription(), $tag->isVariadic() ]; - } elseif ($tag instanceof Return_ && !isset($this->return)) { + } elseif ($tag instanceof Return_ && !isset($this->return) && $this->name !== '__construct') { $this->return = $tag; } elseif ($tag instanceof Generic && $tag->getName() === 'psalm-return') { $this->psalmReturn = $tag; @@ -157,7 +157,7 @@ class MethodDoc extends GenericDoc $sigLink = \preg_replace('/[^\w ]+/', ' ', $sigLink); $sigLink = \preg_replace('/ +/', ' ', $sigLink); $sigLink = \str_replace(' ', '-', $sigLink); - return $sigLink; + return trim($sigLink, '-'); } /** * Generate markdown for method.