Skip to content

Commit d592b6f

Browse files
rodrigoprimojrfnl
andcommitted
Apply suggestions from code review
Co-authored-by: Juliette <[email protected]>
1 parent 500f492 commit d592b6f

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,25 +40,21 @@
4040
</code>
4141
<code title="Invalid: The opening and closing DocBlock tags are not the only content on the line.">
4242
<![CDATA[
43-
<em>/** Short description.</em>
44-
*/
45-
46-
/**
47-
<em>* Short description */</em>
43+
<em>/** Short description. */</em>
4844
]]>
4945
</code>
5046
</code_comparison>
5147
<standard>
5248
<![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.
5450
]]>
5551
</standard>
5652
<code_comparison>
5753
<code title="Valid: no additional blank lines before the closing DocBlock tag.">
5854
<![CDATA[
5955
/**
60-
* Short description.
61-
<em></em> */
56+
* Short description.<em>
57+
</em> */
6258
]]>
6359
</code>
6460
<code title="Invalid: additional blank lines before the closing DocBlock tag.">
@@ -98,11 +94,11 @@
9894
</code_comparison>
9995
<standard>
10096
<![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.
10298
]]>
10399
</standard>
104100
<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.">
106102
<![CDATA[
107103
/**
108104
* <em>S</em>hort description.
@@ -111,7 +107,7 @@
111107
*/
112108
]]>
113109
</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.">
115111
<![CDATA[
116112
/**
117113
* <em>s</em>hort description.
@@ -145,8 +141,8 @@
145141
<em> *
146142
*
147143
</em>
148-
* Long description.
149-
* @param int $foo
144+
* Long description.<em>
145+
</em> * @param int $foo
150146
*/
151147
]]>
152148
</code>
@@ -203,7 +199,7 @@
203199
* Short description.
204200
*
205201
<em> * @param int $foo
206-
* @author Some Author
202+
* @since 5.4.8
207203
* @return int</em>
208204
*/
209205
]]>

0 commit comments

Comments
 (0)