Skip to content

Commit 500f492

Browse files
committed
Group doc for MissingShort and SpacingBeforeShort together
1 parent 1c68da9 commit 500f492

File tree

1 file changed

+4
-21
lines changed

1 file changed

+4
-21
lines changed

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

+4-21
Original file line numberDiff line numberDiff line change
@@ -72,40 +72,23 @@
7272
</code_comparison>
7373
<standard>
7474
<![CDATA[
75-
The DocBlock must have a short description.
75+
The DocBlock must have a short description, and it must be on the first line.
7676
]]>
7777
</standard>
7878
<code_comparison>
79-
<code title="Valid: DocBlock with a short description.">
79+
<code title="Valid: DocBlock with a short description on the first line.">
8080
<![CDATA[
8181
/**
8282
* <em>Short description.</em>
8383
*/
8484
]]>
8585
</code>
86-
<code title="Invalid: DocBlock without a short description.">
86+
<code title="Invalid: DocBlock without a short description or short description not on the first line.">
8787
<![CDATA[
8888
/**
8989
* <em></em>@return int
9090
*/
91-
]]>
92-
</code>
93-
</code_comparison>
94-
<standard>
95-
<![CDATA[
96-
Short description must be on the first line of the DocBlock.
97-
]]>
98-
</standard>
99-
<code_comparison>
100-
<code title="Valid: No blank lines before the short description.">
101-
<![CDATA[
102-
/**<em></em>
103-
* Short description.
104-
*/
105-
]]>
106-
</code>
107-
<code title="Invalid: Blank lines before the short description.">
108-
<![CDATA[
91+
10992
/**
11093
<em> *</em>
11194
* Short description.

0 commit comments

Comments
 (0)