Add documentation to source code

Author: Blargian

src/Functions/array/arrayCount.cpp

@@ -94,7 +94,7 @@ You can pass a lambda function to it as the first argument.
     FunctionDocumentation::Syntax syntax = "arrayCount([func,] arr1, ...)";
     FunctionDocumentation::Arguments arguments = {
         {"func", "Function to apply to each element of the array(s). [Lambda function](/sql-reference/functions/overview#arrow-operator-and-lambda)"},
-        {"arr1 ... arrN", "N arrays"},
+        {"arr1 ... arrN", "N arrays. [Array](/sql-reference/data-types/array)."},
     };
     FunctionDocumentation::ReturnedValue returned_value = "Returns the number of elements for which `func` returns something other than `0`. Otherwise, returns the number of non-zero elements in the array.";
     FunctionDocumentation::Examples example = {{"Usage example", "SELECT arrayCount(x -> (x % 2), groupArray(number) FROM numbers(10)", "5"}};

src/Functions/array/arrayPopBack.cpp

@@ -15,7 +15,16 @@ class FunctionArrayPopBack : public FunctionArrayPop
 
 REGISTER_FUNCTION(ArrayPopBack)
 {
-    factory.registerFunction<FunctionArrayPopBack>();
+    FunctionDocumentation::Description description = "Removes the last element from the array."
+    FunctionDocumentation::Syntax syntax = "arrayPopBack(x)";
+    FunctionDocumentation::Arguments arguments = {{"x", "The array for which to remove the last element from. [`Array`](/sql-reference/data-types/array)."}};
+    FunctionDocumentation::ReturnedValue returned_value = "Returns an array identical to `x` but without the last element of `x`. [`Array`](/sql-reference/data-types/array)."
+    FunctionDocumentation::Examples examples = {{"Usage example", "SELECT arrayPopBack([1, 2, 3]) AS res;", "[1,2]"}};
+    FunctionDocumentation::IntroducedIn introduced_in = {1, 1};
+    FunctionDocumentation::Category category = FunctionDocumentation::Category::Array;
+    FunctionDocumentation documentation = {description, syntax, arguments, returned_value, examples, introduced_in, category};
+
+    factory.registerFunction<FunctionArrayPopBack>(documentation);
 }
 
 }

src/Functions/array/arrayPopFront.cpp

@@ -15,7 +15,16 @@ class FunctionArrayPopFront : public FunctionArrayPop
 
 REGISTER_FUNCTION(ArrayPopFront)
 {
-    factory.registerFunction<FunctionArrayPopFront>();
+    FunctionDocumentation::Description description = "Removes the first item from the array."
+    FunctionDocumentation::Syntax syntax = "arrayPopFront(x)";
+    FunctionDocumentation::Arguments arguments = {{"x", "The array for which to remove the first element from. [`Array`](/sql-reference/data-types/array)."}};
+    FunctionDocumentation::ReturnedValue returned_value = "Returns an array identical to `x` but without the first element of `x`. [`Array`](/sql-reference/data-types/array).";
+    FunctionDocumentation::Examples examples = {{"Usage example", "SELECT arrayPopFront([1, 2, 3]) AS res;", "[2,3]"}};
+    FunctionDocumentation::IntroducedIn introduced_in = {1, 1};
+    FunctionDocumentation::Category category = FunctionDocumentation::Category::Array;
+    FunctionDocumentation documentation = {description, syntax, arguments, returned_value, examples, introduced_in, category};
+
+    factory.registerFunction<FunctionArrayPopFront>(documentation);
 }
 
 }

src/Functions/array/arrayPushBack.cpp

@@ -15,7 +15,29 @@ class FunctionArrayPushBack : public FunctionArrayPush
 
 REGISTER_FUNCTION(ArrayPushBack)
 {
-    factory.registerFunction<FunctionArrayPushBack>();
+    FunctionDocumentation::Description description = "Adds one item to the end of the array.";
+    FunctionDocumentation::Syntax syntax = "arrayPushBack(x, y)";
+    FunctionDocumentation::Arguments arguments = {
+        {"x", "The array for which to add value `y` to the end of. [`Array`](/sql-reference/data-types/array)."},
+        {"y", R"(
+- Single value to add to the end of the array. [`Array`](/sql-reference/data-types/array).
+
+:::note
+- Only numbers can be added to an array with numbers, and only strings can be added to an array of strings.
+- When adding numbers, ClickHouse automatically sets the type of `y` for the data type of the array.
+- Can be `NULL`. The function adds a `NULL` element to an array, and the type of array elements converts to `Nullable`.
+
+For more information about the types of data in ClickHouse, see [Data types](/sql-reference/data-types).
+:::
+    )"},
+    };
+    FunctionDocumentation::ReturnedValue returned_value = "Returns an array identical to `x` but with an additional value `y` at the end of the array. [`Array`](/sql-reference/data-types/array).";
+    FunctionDocumentation::Examples examples = {{"Usage example", "SELECT arrayPushBack(['a'], 'b') AS res;", "['a','b']"}};
+    FunctionDocumentation::IntroducedIn introduced_in = {1, 1};
+    FunctionDocumentation::Category category = FunctionDocumentation::Category::Array;
+    FunctionDocumentation documentation = {description, syntax, arguments, returned_value, examples, introduced_in, category};
+
+    factory.registerFunction<FunctionArrayPushBack>(documentation);
 }
 
 }

src/Functions/array/arrayPushFront.cpp

@@ -17,7 +17,29 @@ class FunctionArrayPushFront : public FunctionArrayPush
 
 REGISTER_FUNCTION(ArrayPushFront)
 {
-    factory.registerFunction<FunctionArrayPushFront>();
+    FunctionDocumentation::Description description = "Adds one element to the beginning of the array.";
+    FunctionDocumentation::Syntax syntax = "arrayPushFront(x, y)";
+    FunctionDocumentation::Arguments arguments = {
+        {"x", "The array for which to add value `y` to the end of. [`Array`](/sql-reference/data-types/array)."},
+        {"y", R"(
+- Single value to add to the start of the array. [`Array`](/sql-reference/data-types/array).
+
+:::note
+- Only numbers can be added to an array with numbers, and only strings can be added to an array of strings.
+- When adding numbers, ClickHouse automatically sets the type of `y` for the data type of the array.
+- Can be `NULL`. The function adds a `NULL` element to an array, and the type of array elements converts to `Nullable`.
+
+For more information about the types of data in ClickHouse, see [Data types](/sql-reference/data-types).
+:::
+    )"},
+    };
+    FunctionDocumentation::ReturnedValue returned_value = "Returns an array identical to `x` but with an additional value `y` at the beginning of the array. [`Array`](/sql-reference/data-types/array).";
+    FunctionDocumentation::Examples examples = {{"Usage example", "SELECT arrayPushFront(['b'], 'a') AS res;", "['a','b']"}};
+    FunctionDocumentation::IntroducedIn introduced_in = {1, 1};
+    FunctionDocumentation::Category category = FunctionDocumentation::Category::Array;
+    FunctionDocumentation documentation = {description, syntax, arguments, returned_value, examples, introduced_in, category};
+
+    factory.registerFunction<FunctionArrayPushFront>(documentation);
 }
 
 }

tests/queries/0_stateless/02415_all_new_functions_must_be_documented.reference

@@ -117,11 +117,7 @@ arrayLastOrNull
 arrayMap
 arrayMax
 arrayMin
-arrayPopBack
-arrayPopFront
 arrayProduct
-arrayPushBack
-arrayPushFront
 arrayROCAUC
 arrayRandomSample
 arrayReduce

tests/queries/0_stateless/02415_all_new_functions_must_have_version_information.reference

@@ -146,8 +146,6 @@ arrayPartialSort
 arrayPopBack
 arrayPopFront
 arrayProduct
-arrayPushBack
-arrayPushFront
 arrayROCAUC
 arrayRandomSample
 arrayReduce