danog/phpdoc
1
0
Fork 0
mirror of https://github.com/danog/phpdoc.git synced 2024-11-26 12:04:47 +01:00
Code Issues Projects Releases Wiki Activity

Fixes

Browse Source
This commit is contained in:
Daniil Gentili 2023-06-27 19:48:00 +02:00
parent 563e8087d3
commit ab8444e667
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
2 changed files with 36 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/PhpDoc/ClassDoc.php
View File

@ -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;

4
src/PhpDoc/MethodDoc.php
View File

@ -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.