File tree 1 file changed +10
-14
lines changed
src/Standards/Generic/Docs/Commenting 1 file changed +10
-14
lines changed Original file line number Diff line number Diff line change 40
40
</code >
41
41
<code title =" Invalid: The opening and closing DocBlock tags are not the only content on the line." >
42
42
<![CDATA[
43
- <em>/** Short description.</em>
44
- */
45
-
46
- /**
47
- <em>* Short description */</em>
43
+ <em>/** Short description. */</em>
48
44
]]>
49
45
</code >
50
46
</code_comparison >
51
47
<standard >
52
48
<![CDATA[
53
- There must be no additional blank lines before the closing DocBlock tag.
49
+ There must be no additional blank (comment) lines before the closing DocBlock tag.
54
50
]]>
55
51
</standard >
56
52
<code_comparison >
57
53
<code title =" Valid: no additional blank lines before the closing DocBlock tag." >
58
54
<![CDATA[
59
55
/**
60
- * Short description.
61
- <em>< /em> */
56
+ * Short description.<em>
57
+ </em> */
62
58
]]>
63
59
</code >
64
60
<code title =" Invalid: additional blank lines before the closing DocBlock tag." >
98
94
</code_comparison >
99
95
<standard >
100
96
<![CDATA[
101
- The short and long descriptions must start with a capital letter.
97
+ Both the short description, as well as the long description, must start with a capital letter.
102
98
]]>
103
99
</standard >
104
100
<code_comparison >
105
- <code title =" Valid: Short and long descriptions start with a capital letter." >
101
+ <code title =" Valid: Both the short and long description start with a capital letter." >
106
102
<![CDATA[
107
103
/**
108
104
* <em>S</em>hort description.
111
107
*/
112
108
]]>
113
109
</code >
114
- <code title =" Invalid: Short or long descriptions don't start with a capital letter." >
110
+ <code title =" Invalid: Neither short nor long description starts with a capital letter." >
115
111
<![CDATA[
116
112
/**
117
113
* <em>s</em>hort description.
145
141
<em> *
146
142
*
147
143
</em>
148
- * Long description.
149
- * @param int $foo
144
+ * Long description.<em>
145
+ </em> * @param int $foo
150
146
*/
151
147
]]>
152
148
</code >
203
199
* Short description.
204
200
*
205
201
<em> * @param int $foo
206
- * @author Some Author
202
+ * @since 5.4.8
207
203
* @return int</em>
208
204
*/
209
205
]]>
You can’t perform that action at this time.
0 commit comments