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