Skip to content

Commit 517e037

Browse files
committed
adjust return tag verbiage regarding when to use it
1 parent b6242a1 commit 517e037

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

proposed/phpdoc-tags.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -696,9 +696,10 @@ RECOMMENDED in case of complicated return structures, such as associative arrays
696696
The @return tag MAY have a multi-line description and does not need explicit
697697
delimiting.
698698

699-
It is RECOMMENDED to use this tag with every function and method. The @return
700-
tag MAY be omitted by functions and methods without a `return` value, in which
701-
case an interpreter MUST interpret this as if `@return void` is provided.
699+
It is RECOMMENDED to use this tag with every function and method.
700+
If no `@return` type is given, and no return type declaration is provided in
701+
the code signature, an interpreter MUST interpret this as if `@return mixed`
702+
is provided.
702703

703704
This tag MUST NOT occur more than once in a "DocBlock" and is limited to the
704705
"DocBlock" of a "Structural Element" of a method or function.

0 commit comments

Comments
 (0)