Skip to content

Commit 8ec7ef2

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

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,15 @@
5050
</code_comparison>
5151
<standard>
5252
<![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.
5454
]]>
5555
</standard>
5656
<code_comparison>
5757
<code title="Valid: no additional blank lines before the closing DocBlock tag.">
5858
<![CDATA[
5959
/**
60-
* Short description.
61-
<em></em> */
60+
* Short description.<em>
61+
</em> */
6262
]]>
6363
</code>
6464
<code title="Invalid: additional blank lines before the closing DocBlock tag.">
@@ -98,11 +98,11 @@
9898
</code_comparison>
9999
<standard>
100100
<![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.
102102
]]>
103103
</standard>
104104
<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.">
106106
<![CDATA[
107107
/**
108108
* <em>S</em>hort description.
@@ -111,7 +111,7 @@
111111
*/
112112
]]>
113113
</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.">
115115
<![CDATA[
116116
/**
117117
* <em>s</em>hort description.
@@ -145,8 +145,8 @@
145145
<em> *
146146
*
147147
</em>
148-
* Long description.
149-
* @param int $foo
148+
* Long description.<em>
149+
</em> * @param int $foo
150150
*/
151151
]]>
152152
</code>
@@ -203,7 +203,7 @@
203203
* Short description.
204204
*
205205
<em> * @param int $foo
206-
* @author Some Author
206+
* @since 5.4.8
207207
* @return int</em>
208208
*/
209209
]]>

0 commit comments

Comments
 (0)