You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: proposed/phpdoc.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ interpreted as described in [RFC 2119][RFC2119].
41
41
preceded by a DocBlock. The collection contains the following constructs:
42
42
43
43
*`require` / `include` (and their `\_once` variants)
44
-
*`class` / `interface` / `trait` / `enum`
44
+
*`classlike` constructs. Including `class`, `interface`, `trait`, `enum` and others later added.
45
45
*`function` (both standalone functions and class methods)
46
46
* variables (local and global scope) and class properties
47
47
* constants (global constants via `define` and class constants)
@@ -156,7 +156,7 @@ interpreted as described in [RFC 2119][RFC2119].
156
156
The PHPDoc format has the following [ABNF][RFC5234] definition:
157
157
158
158
PHPDoc = [summary [description]] [tags]
159
-
eol = [CR] LF ; to be compatible with PSR-12
159
+
eol = [CR] LF ; to be compatible with [CS-PER]
160
160
summary = 1*CHAR 2*eol
161
161
description = 1*(CHAR / inline-tag) 1*eol ; any amount of characters
162
162
; with inline tags inside
@@ -173,9 +173,7 @@ Examples of use are included in chapter 5.4.
173
173
174
174
### 5.1. Summary
175
175
176
-
A Summary MUST provide an abstract of the "Structural Element" defining the
177
-
purpose. It is RECOMMENDED for Summaries to span a single line or two, but not
178
-
more than that.
176
+
A Summary MUST be a concise abstract of the Structural Element\u2019s purpose. It is RECOMMENDED to keep the Summary to a single line, though two lines MAY be used if needed.
179
177
180
178
A Summary MUST end with two sequential line breaks, unless it is the only
0 commit comments