Skip to content

Commit dc22715

Browse files
committed
Apply remaining suggestions from code review
1 parent d592b6f commit dc22715

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

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

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Doc Comment">
22
<standard>
33
<![CDATA[
4-
Enforces several rules related to the formatting of DocBlocks in PHP code.
4+
Enforces rules related to the formatting of DocBlocks in PHP code. DocBlocks are, as defined by the phpDocumentor project, a special type of comment that can provide information about a structural element. In the context of DocBlocks, structural elements are require(_once), include(_once), class, interface, trait, function, property, constant and variable. But this sniff is triggered whenever it finds a DocBlock opening tag ("/**"). The sniff name can be misleading. Despite Doc Comment being the name, this sniff is about DocBlocks.
55
]]>
66
</standard>
77
<standard>
@@ -31,14 +31,14 @@
3131
]]>
3232
</standard>
3333
<code_comparison>
34-
<code title="Valid: The opening and closing DocBlock tags are the only content on the line.">
34+
<code title="Valid: The opening and closing DocBlock tags have to be on a line by themselves.">
3535
<![CDATA[
3636
<em>/**</em>
3737
* Short description.
3838
<em>*/</em>
3939
]]>
4040
</code>
41-
<code title="Invalid: The opening and closing DocBlock tags are not the only content on the line.">
41+
<code title="Invalid: The opening and closing DocBlock tags are not on a line by themselves.">
4242
<![CDATA[
4343
<em>/** Short description. */</em>
4444
]]>
@@ -186,10 +186,10 @@
186186
/**
187187
* Short description.
188188
*
189-
* @param int $foo
189+
<em> * @param int $foo</em>
190190
*
191-
<em> * @author Some Author
192-
* @return int</em>
191+
* @since 3.4.8
192+
* @deprecated 6.0.0
193193
*/
194194
]]>
195195
</code>
@@ -198,9 +198,9 @@
198198
/**
199199
* Short description.
200200
*
201-
<em> * @param int $foo
202-
* @since 5.4.8
203-
* @return int</em>
201+
<em> * @param int $foo
202+
* @since 3.4.8
203+
* @deprecated 6.0.0</em>
204204
*/
205205
]]>
206206
</code>
@@ -216,8 +216,8 @@
216216
/**
217217
* Short description.
218218
*
219-
* @deprecated <em>1.0.0</em>
220-
* @return <em>bool</em>
219+
* @since<em> 0.5.0</em>
220+
* @deprecated<em> 1.0.0</em>
221221
*/
222222
]]>
223223
</code>
@@ -226,8 +226,8 @@
226226
/**
227227
* Short description.
228228
*
229-
* @deprecated <em>1.0.0</em>
230-
* @return <em>bool</em>
229+
* @since<em> 0.5.0</em>
230+
* @deprecated<em> 1.0.0</em>
231231
*/
232232
]]>
233233
</code>

0 commit comments

Comments
 (0)