Skip to content

Fix up return descr #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dereuromark merged 4 commits into from
Oct 27, 2025
Merged

Fix up return descr #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f22b28
Fix up return descr
dereuromark Oct 23, 2025
a2a3331
Merge remote-tracking branch 'origin/2.x' into 2.x-return
dereuromark Oct 23, 2025
d4a7984
Merge branch '2.x' into 2.x-return
ADmad Oct 27, 2025
72fa760
Revert changes to composer.lock
ADmad Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Factory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ protected function reflectFuncLike(ReflectedFunction $func, FunctionLike $node,
$func->nativeReturnType = DocUtil::parseType(PrintUtil::node($node->getReturnType()));
}
$func->returnType = $doc->tags['return']?->type ?? $func->nativeReturnType;
$func->returnDescription = $doc->tags['return']?->description ?? '';
}

/**
Expand Down
2 changes: 2 additions & 0 deletions src/Reflection/ReflectedFunction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ class ReflectedFunction extends ReflectedNode

public ?TypeNode $nativeReturnType = null;

public string $returnDescription = '';

public bool $abstract = false;

public bool $static = false;
Expand Down
4 changes: 3 additions & 1 deletion templates/pages/parts/function-detail.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@
<h6>Returns</h6>
<div class="list">
<code>{{ function.returnType|type }}</code><br>
{# {{ (return.description ?? '')|markdown_to_html }} #}
{% if function.returnDescription %}
{{ function.returnDescription|markdown_to_html }}
{% endif %}
</div>
{% endif %}

Expand Down
Loading