Skip to content

Commit 81abb4d

Browse files
committed
Descriptions should always allow multiline format, so no need to explicitly mention it on just two tags
1 parent 517e037 commit 81abb4d

File tree

2 files changed

+0
-8
lines changed

2 files changed

+0
-8
lines changed

proposed/phpdoc-tags.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -604,9 +604,6 @@ single parameter of a function or method. When provided it MUST contain a
604604
@param tags are omitted due to all useful info already being visible in the
605605
code signature itself. The description is OPTIONAL yet RECOMMENDED.
606606

607-
The @param tag MAY have a multi-line description and does not need explicit
608-
delimiting.
609-
610607
It is RECOMMENDED when documenting to use this tag with every function and
611608
method.
612609

@@ -693,9 +690,6 @@ function or method. When provided, it MUST contain a "Type"
693690
to indicate what is returned; the description on the other hand is OPTIONAL yet
694691
RECOMMENDED in case of complicated return structures, such as associative arrays.
695692

696-
The @return tag MAY have a multi-line description and does not need explicit
697-
delimiting.
698-
699693
It is RECOMMENDED to use this tag with every function and method.
700694
If no `@return` type is given, and no return type declaration is provided in
701695
the code signature, an interpreter MUST interpret this as if `@return mixed`
@@ -928,7 +922,6 @@ function initializeXml()
928922
}
929923
```
930924

931-
<<<<<<< HEAD
932925
```php
933926
/**
934927
* @uses MyView.php

proposed/phpdoc.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ interpreted as described in [RFC 2119][RFC2119].
118118
}
119119
```
120120

121-
<<<<<<< HEAD
122121
It is NOT RECOMMENDED to use compound definitions for Constants or Properties, since the
123122
handling of DocBlocks in these situations can lead to unexpected results. If compound statement is
124123
used each element SHOULD have a preceding DocBlock.

0 commit comments

Comments
 (0)