Skip to content

Fix getting parameter types from the @method annotation #329

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
merged 3 commits into from
Nov 16, 2025
Merged

Fix getting parameter types from the @method annotation #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e8566b
Fix parameter types in the `@method` annotation
mspirkov Nov 16, 2025
7c7197c
Merge branch 'master' into fix-displaying-param-types
mspirkov Nov 16, 2025
25f263d
changelog
mspirkov Nov 16, 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 CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Yii Framework 2 apidoc extension Change Log
- Bug #324: Raise minimum PHP version to 7.4 (mspirkov)
- Bug #325: Fix deprecation errors `The Default value will become of type Expression by default` (mspirkov)
- Bug #327: Fix deprecation errors `The expression value will become of type Expression by default` (mspirkov)
- Bug #329: Fix getting parameter types from the `@method` annotation (mspirkov)


3.0.7 February 13, 2025
Expand Down
2 changes: 1 addition & 1 deletion models/TypeDoc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ public function __construct($reflector = null, $context = null, $config = [])
'name' => $parameter->getName(),
'typeHint' => $argumentType,
'type' => $argumentType,
'types' => [],
'types' => [$argumentType],
]);
}

Expand Down
10 changes: 8 additions & 2 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,11 +437,17 @@ <h2>Method Details</h2>

<table class="detail-table table table-striped table-bordered table-hover">
<tr><td colspan="3" class="signature">
<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span> )</td></tr>
<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span>, <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <span style="color: #0000BB">$test2</span> )</td></tr>

<tr>
<td class="param-name-col"><span style="color: #0000BB">$test</span></td>
<td class="param-type-col"></td>
<td class="param-type-col"><a href="https://www.php.net/language.types.mixed">mixed</a></td>
<td class="param-desc-col">
</td>
</tr>
<tr>
<td class="param-name-col"><span style="color: #0000BB">$test2</span></td>
<td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
<td class="param-desc-col">
</td>
</tr>
Expand Down
10 changes: 8 additions & 2 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__2.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,17 @@ <h2>Method Details</h2>

<table class="detail-table table table-striped table-bordered table-hover">
<tr><td colspan="3" class="signature">
<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span> )</td></tr>
<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span>, <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <span style="color: #0000BB">$test2</span> )</td></tr>

<tr>
<td class="param-name-col"><span style="color: #0000BB">$test</span></td>
<td class="param-type-col"></td>
<td class="param-type-col"><a href="https://www.php.net/language.types.mixed">mixed</a></td>
<td class="param-desc-col">
</td>
</tr>
<tr>
<td class="param-name-col"><span style="color: #0000BB">$test2</span></td>
<td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
<td class="param-desc-col">
</td>
</tr>
Expand Down
10 changes: 8 additions & 2 deletions tests/commands/__snapshots__/ApiControllerTest__testGenerateBootstrap__3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,11 +318,17 @@ <h2>Method Details</h2>

<table class="detail-table table table-striped table-bordered table-hover">
<tr><td colspan="3" class="signature">
<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span> )</td></tr>
<span class="signature-defs">public</span> <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <strong><a href="yiiunit-apidoc-data-api-animal-animal.html#getSomething()-detail">getSomething</a></strong> ( <span style="color: #0000BB">$test</span>, <span class="signature-type"><a href="https://www.php.net/language.types.integer">integer</a></span> <span style="color: #0000BB">$test2</span> )</td></tr>

<tr>
<td class="param-name-col"><span style="color: #0000BB">$test</span></td>
<td class="param-type-col"></td>
<td class="param-type-col"><a href="https://www.php.net/language.types.mixed">mixed</a></td>
<td class="param-desc-col">
</td>
</tr>
<tr>
<td class="param-name-col"><span style="color: #0000BB">$test2</span></td>
<td class="param-type-col"><a href="https://www.php.net/language.types.integer">integer</a></td>
<td class="param-desc-col">
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion tests/data/api/animal/Animal.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @property int $age animal age in seconds.
*
* @method int getSomething($test)
* @method int getSomething($test, int $test2)
*
* @author Paul Klimov <klimov.paul@gmail.com>
* @since 1.0
Expand Down
Loading