Skip to content

Commit c0747c7

Browse files
costdevjrfnl
andauthored
Apply suggestions from code review
Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com>
1 parent 576382c commit c0747c7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/Standards/Squiz/Docs/Commenting/BlockCommentStandard.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,16 +90,16 @@
9090
</code_comparison>
9191
<standard>
9292
<![CDATA[
93-
If asterisks are not used, the contents should be indented by at least 4 spaces.
93+
If there are no asterisks at the start of each line, the contents of the docblock should be indented by at least 4 spaces.
9494
]]>
9595
</standard>
9696
<code_comparison>
9797
<code title="Valid: Indented by at least 4 spaces.">
9898
<![CDATA[
9999
/*
100100
A block comment
101-
with
102-
multiple lines.
101+
with multiple lines.
102+
And a second paragraph.
103103
*/
104104
]]>
105105
</code>
@@ -165,14 +165,14 @@
165165
]]>
166166
</standard>
167167
<code_comparison>
168-
<code title="Valid: Uses multiple lines.">
168+
<code title="Valid: Multi-line block comment.">
169169
<![CDATA[
170170
/*
171171
A block comment.
172172
*/
173173
]]>
174174
</code>
175-
<code title="Invalid: Uses a single line.">
175+
<code title="Invalid: Single line block comment.">
176176
<![CDATA[
177177
<em>/* A block comment. */</em>
178178
]]>

0 commit comments

Comments
 (0)