From 0b816732ff21bef90199b42ec0215e3226a85392 Mon Sep 17 00:00:00 2001
From: Rodrigo Primo <rodrigosprimo@gmail.com>
Date: Thu, 31 Oct 2024 09:44:40 -0300
Subject: [PATCH] Generic/ArrayIndent: add XML documentation (#432)

---
 .../Docs/Arrays/ArrayIndentStandard.xml       | 107 ++++++++++++++++++
 1 file changed, 107 insertions(+)
 create mode 100644 src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml

diff --git a/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
new file mode 100644
index 0000000000..0312a70f15
--- /dev/null
+++ b/src/Standards/Generic/Docs/Arrays/ArrayIndentStandard.xml
@@ -0,0 +1,107 @@
+<documentation title="Array Indent">
+    <standard>
+    <![CDATA[
+    The opening brace of a multi-line array must be indented at least to the same level as the start of the statement.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Opening brace of a multi-line array indented to the same level as the start of the statement.">
+        <![CDATA[
+$b = <em>[</em>
+    1,
+    2,
+];
+
+if ($condition) {
+    $a =
+<em>    [</em>
+        1,
+        2,
+    ];
+}
+
+        ]]>
+        </code>
+        <code title="Invalid: Opening brace of a multi-line array not indented to the same level as the start of the statement.">
+        <![CDATA[
+if ($condition) {
+    $a =
+<em>[</em>
+        1,
+        2,
+    ];
+}
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    Each array element must be indented exactly four spaces from the start of the statement.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Each array element is indented by exactly four spaces.">
+        <![CDATA[
+$a = array(
+<em>    </em>1,
+<em>    </em>2,
+<em>    </em>3,
+);
+        ]]>
+        </code>
+        <code title="Invalid: Array elements not indented by four spaces.">
+        <![CDATA[
+$a = array(
+<em>  </em>1,
+<em>     </em>2,
+<em>        </em>3,
+);
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    The array closing brace must be on a new line.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Array closing brace on its own line.">
+        <![CDATA[
+$a = [
+    1,
+    2,<em>
+]</em>;
+        ]]>
+        </code>
+        <code title="Invalid: Array closing brace not on its own line.">
+        <![CDATA[
+$a = [
+    1,
+    2,<em>]</em>;
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    The closing brace must be aligned with the start of the statement containing the array opener.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Closing brace aligned with the start of the statement containing the array opener.">
+        <![CDATA[
+$a = array(
+    1,
+    2,
+<em>)</em>;
+        ]]>
+        </code>
+        <code title="Invalid: Closing brace not aligned with the start of the statement containing the array opener.">
+        <![CDATA[
+$a = array(
+    1,
+    2,
+<em>  )</em>;
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>