Skip to content

Commit 0ee358c

Browse files
committed
Fix typo in PointerName description
1 parent 0d1f3e1 commit 0ee358c

File tree

1 file changed

+12
-11
lines changed
  • delphi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi

1 file changed

+12
-11
lines changed

delphi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/PointerName.html

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,33 @@
11
<h2>Why is this an issue?</h2>
22
<p>
33
Code that follows a consistent naming convention is self-documenting. In Delphi, all pointer names
4-
should be named identically to the dereferenced type, with the type prefix swapped for <code>P</code>.
4+
should be named identically to the dereferenced type, with the type prefix swapped for
5+
<code>P</code>.
56
</p>
67
<p>
7-
For example, the pointer types for <code>TMyType</code>,
8-
<code>EMyType</code>, and <code>IMyType</code> should be named <code>PMyType</code>.
8+
For example, the pointer types for <code>TMyType</code>, <code>EMyType</code>, and
9+
<code>IMyType</code> should be named <code>PMyType</code>.
910
</p>
1011
<p>
11-
Custom prefixes for dereferenced types are also supported,
12-
provided they also start with <code>T</code>, <code>E</code> or <code>I</code>.
12+
Custom prefixes for dereferenced types are also supported, provided they also start with
13+
<code>T</code>, <code>E</code> or <code>I</code>.
1314
</p>
1415
<p>
15-
For example, the pointer types for <code>TxyMyType</code>,
16-
<code>ExyMyType</code>, and <code>IxyMyType</code> should be named <code>PxyMyType</code>.
16+
For example, the pointer types for <code>TxyMyType</code>, <code>ExyMyType</code>, and
17+
<code>IxyMyType</code> should be named <code>PxyMyType</code>.
1718
</p>
1819
<p>
19-
If dereferenced type is in PascalCase but does not have a valid prefix,
20-
the pointer name is expected to be the same as the type name but with the addition of the prefix <code>P</code>.
20+
If the dereferenced type is in PascalCase but does not have a valid prefix, the pointer name is
21+
expected to be the same as the type name but with the addition of the prefix <code>P</code>.
2122
</p>
2223
<p>For example:</p>
2324
<ul>
2425
<li><code>^MyObject</code> should be named <code>PMyObject</code></li>
2526
<li><code>^MyType</code> should be named <code>PMyType</code></li>
2627
</ul>
2728
<p>
28-
Note that pointers to types that do not follow the naming standard are valid
29-
as long as they are in PascalCase with the prefix <code>P</code>.
29+
Note that pointers to types that do not follow the naming standard are valid as long as they are
30+
in PascalCase with the prefix <code>P</code>.
3031
</p>
3132
<p>For example:</p>
3233
<ul>

0 commit comments

Comments
 (0)