Skip to content

Commit ec3ecdc

Browse files
gen_stub: documentation updates
* Use `@param` instead of `@var` for parameters * Fix type of `$attributeGroups` in `AttributeInfo::createFromGroups()` * Remove extra documentation of `$allConstInfo` for `ClassInfo::getClassSynopsisDocument()`, it is already documented under the correct name `$allConstInfos` * Remove unneeded `@throws`
1 parent 722eba2 commit ec3ecdc

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

build/gen_stub.php

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1683,9 +1683,6 @@ private function generateRefSect1(DOMDocument $doc, string $role): DOMElement {
16831683
return $refSec;
16841684
}
16851685

1686-
/**
1687-
* @throws Exception
1688-
*/
16891686
public function getMethodSynopsisDocument(): ?string {
16901687
$REFSEC1_SEPERATOR = "\n\n ";
16911688

@@ -2114,9 +2111,6 @@ private function getExampleSection(DOMDocument $doc, string $id): DOMElement {
21142111
return $refSec;
21152112
}
21162113

2117-
/**
2118-
* @throws Exception
2119-
*/
21202114
public function getMethodSynopsisElement(DOMDocument $doc): ?DOMElement {
21212115
if ($this->hasParamWithUnknownDefaultValue()) {
21222116
return null;
@@ -2438,7 +2432,7 @@ abstract class VariableLike
24382432
protected /* readonly */ ?ExposedDocComment $exposedDocComment;
24392433

24402434
/**
2441-
* @var AttributeInfo[] $attributes
2435+
* @param AttributeInfo[] $attributes
24422436
*/
24432437
public function __construct(
24442438
int $flags,
@@ -2621,7 +2615,7 @@ class ConstInfo extends VariableLike
26212615
private /* readonly */ bool $isFileCacheAllowed;
26222616

26232617
/**
2624-
* @var AttributeInfo[] $attributes
2618+
* @param AttributeInfo[] $attributes
26252619
*/
26262620
public function __construct(
26272621
AbstractConstName $name,
@@ -3075,7 +3069,7 @@ class PropertyInfo extends VariableLike
30753069
];
30763070

30773071
/**
3078-
* @var AttributeInfo[] $attributes
3072+
* @param AttributeInfo[] $attributes
30793073
*/
30803074
public function __construct(
30813075
PropertyName $name,
@@ -3373,7 +3367,7 @@ public function generateCode(string $invocation, string $nameSuffix, array $allC
33733367
}
33743368

33753369
/**
3376-
* @param array<int, array<int, AttributeGroup>> $attributeGroups
3370+
* @param AttributeGroup[] $attributeGroups
33773371
* @return AttributeInfo[]
33783372
*/
33793373
public static function createFromGroups(array $attributeGroups): array {
@@ -3733,7 +3727,6 @@ public function discardInfoForOldPhpVersions(?int $phpVersionIdMinimumCompatibil
37333727
/**
37343728
* @param array<string, ClassInfo> $classMap
37353729
* @param array<string, ConstInfo> $allConstInfos
3736-
* @param iterable<ConstInfo> $allConstInfo
37373730
*/
37383731
public function getClassSynopsisDocument(array $classMap, array $allConstInfos): ?string {
37393732
$doc = new DOMDocument();

0 commit comments

Comments
 (0)