Skip to content

Commit a4eb353

Browse files
committed
More strict description of summary.
1 parent 229d134 commit a4eb353

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

proposed/phpdoc.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ interpreted as described in [RFC 2119][RFC2119].
4141
preceded by a DocBlock. The collection contains the following constructs:
4242

4343
* `require` / `include` (and their `\_once` variants)
44-
* `class` / `interface` / `trait` / `enum`
44+
* `classlike` constructs. Including `class`, `interface`, `trait`, `enum` and others later added.
4545
* `function` (both standalone functions and class methods)
4646
* variables (local and global scope) and class properties
4747
* constants (global constants via `define` and class constants)
@@ -156,7 +156,7 @@ interpreted as described in [RFC 2119][RFC2119].
156156
The PHPDoc format has the following [ABNF][RFC5234] definition:
157157

158158
PHPDoc = [summary [description]] [tags]
159-
eol = [CR] LF ; to be compatible with PSR-12
159+
eol = [CR] LF ; to be compatible with [CS-PER]
160160
summary = 1*CHAR 2*eol
161161
description = 1*(CHAR / inline-tag) 1*eol ; any amount of characters
162162
; with inline tags inside
@@ -173,9 +173,7 @@ Examples of use are included in chapter 5.4.
173173

174174
### 5.1. Summary
175175

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.
179177

180178
A Summary MUST end with two sequential line breaks, unless it is the only
181179
content in the PHPDoc.

0 commit comments

Comments
 (0)