File tree 1 file changed +4
-21
lines changed
src/Standards/Generic/Docs/Commenting
1 file changed +4
-21
lines changed Original file line number Diff line number Diff line change 72
72
</code_comparison >
73
73
<standard >
74
74
<![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 .
76
76
]]>
77
77
</standard >
78
78
<code_comparison >
79
- <code title =" Valid: DocBlock with a short description." >
79
+ <code title =" Valid: DocBlock with a short description on the first line ." >
80
80
<![CDATA[
81
81
/**
82
82
* <em>Short description.</em>
83
83
*/
84
84
]]>
85
85
</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 ." >
87
87
<![CDATA[
88
88
/**
89
89
* <em></em>@return int
90
90
*/
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
+
109
92
/**
110
93
<em> *</em>
111
94
* Short description.
You can’t perform that action at this time.
0 commit comments