Generic/EmptyPHPStatement: add XML documentation (#166)

* Generic/EmptyPHPStatement: add documentation * Fix one of the invalid examples in EmptyPHPStatementStandard.xml
PHPCSStandards · Jan 5, 2024 · f8e0b67 · f8e0b67
1 parent 0c9a88b
commit f8e0b67
Showing 1 changed file with 44 additions and 0 deletions.
diff --git a/src/Standards/Generic/Docs/CodeAnalysis/EmptyPHPStatementStandard.xml b/src/Standards/Generic/Docs/CodeAnalysis/EmptyPHPStatementStandard.xml
@@ -0,0 +1,44 @@
+<documentation title="Empty PHP Statement">
+    <standard>
+    <![CDATA[
+    Empty PHP tags are not allowed.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: There is at least one statement inside the PHP tag pair.">
+        <![CDATA[
+<?php <em>echo 'Hello World';</em> ?>
+<?= <em>'Hello World';</em> ?>
+        ]]>
+        </code>
+        <code title="Invalid: There is no statement inside the PHP tag pair.">
+        <![CDATA[
+<?php <em>;</em> ?>
+<?= <em></em> ?>
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    Superfluous semi-colons are not allowed.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: There is no superfluous semi-colon after a PHP statement.">
+            <![CDATA[
+function_call()<em>;</em>
+if (true) {
+    echo 'Hello World'<em>;</em>
+}
+        ]]>
+        </code>
+        <code title="Invalid: There are one or more superfluous semi-colons after a PHP statement.">
+            <![CDATA[
+function_call()<em>;;;</em>
+if (true) {
+    echo 'Hello World';
+}<em>;</em>
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>