From cfae459de023bf0ca68acc76583478205e9cfe11 Mon Sep 17 00:00:00 2001
From: Jay McPartland <jay@bigbite.net>
Date: Mon, 4 Mar 2024 12:40:09 +0000
Subject: [PATCH] Docs: add documentation for Squiz.WhiteSpace.FunctionSpacing

---
 .../WhiteSpace/FunctionSpacingStandard.xml    | 185 ++++++++++++++++++
 1 file changed, 185 insertions(+)
 create mode 100644 src/Standards/Squiz/Docs/WhiteSpace/FunctionSpacingStandard.xml

diff --git a/src/Standards/Squiz/Docs/WhiteSpace/FunctionSpacingStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/FunctionSpacingStandard.xml
new file mode 100644
index 0000000000..d6b9653703
--- /dev/null
+++ b/src/Standards/Squiz/Docs/WhiteSpace/FunctionSpacingStandard.xml
@@ -0,0 +1,185 @@
+<documentation title="Function Spacing">
+    <standard>
+    <![CDATA[
+    There should be exactly 2 blank lines before a function within a statement group or control structure when it is the first block of code.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Exactly 2 blank lines before the first function.">
+        <![CDATA[
+class MyClass
+{<em>
+
+
+</em>    public function foo() {
+    }
+
+
+}
+        ]]>
+        </code>
+        <code title="Invalid: Too few blank lines before the first function.">
+        <![CDATA[
+class MyClass
+{<em>
+
+</em>    public function foo() {
+    }
+
+
+}
+        ]]>
+        </code>
+    </code_comparison>
+    <code_comparison>
+        <code title="Valid: Exactly 2 blank lines before the first function.">
+        <![CDATA[
+if ($something) {<em>
+
+
+</em>    function foo() {
+    }
+
+
+    function bar() {
+    }
+
+
+}
+        ]]>
+        </code>
+        <code title="Invalid: Too many blank lines before the first function.">
+        <![CDATA[
+if ($something) {<em>
+
+
+
+</em>    function foo() {
+    }
+
+
+    function bar() {
+    }
+
+
+}
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    There should be exactly 2 blank lines before and after a function declaration.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Exactly 2 blank lines before and after function declarations.">
+        <![CDATA[
+interface MyInterface
+{
+
+
+    public function foo();<em>
+
+
+</em>    public function bar();<em>
+
+
+</em>    public function baz();
+
+
+}
+        ]]>
+        </code>
+        <code title="Invalid: Incorrect number of blank lines before/after function declarations.">
+        <![CDATA[
+interface MyInterface
+{
+
+
+    public function foo();<em>
+</em>    public function bar();<em>
+
+
+
+</em>    public function baz();
+
+
+}
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    There should be exactly two blank lines after a function within a statement group or control structure when it is the last block of code.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Exactly 2 blank lines after the last function.">
+        <![CDATA[
+trait MyTrait
+{
+
+
+    public function foo() {
+    }
+
+
+    public function bar() {
+    }<em>
+
+
+</em>}
+        ]]>
+        </code>
+        <code title="Invalid: Too few blank lines after the last function.">
+        <![CDATA[
+trait MyTrait
+{
+
+
+    public function foo() {
+    }
+
+
+    public function bar() {
+    }<em>
+</em>}
+        ]]>
+        </code>
+    </code_comparison>
+    <code_comparison>
+        <code title="Valid: Exactly 2 blank lines after the last function.">
+        <![CDATA[
+if ($something) {
+
+
+    function foo() {
+    }
+
+
+    function bar() {
+    }<em>
+
+
+</em>}
+        ]]>
+        </code>
+        <code title="Invalid: Too many blank lines after the last function.">
+        <![CDATA[
+if ($something) {
+
+
+    function foo() {
+    }
+
+
+    function bar() {
+    }<em>
+
+
+
+</em>}
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>