Skip to content

Commit 7e26ad4

Browse files
fix in-source documentations
1 parent e916901 commit 7e26ad4

File tree

2 files changed

+46
-4
lines changed

2 files changed

+46
-4
lines changed

src/Functions/stringBytesEntropy.cpp

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,29 @@ using FunctionStringBytesEntropy = FunctionStringBytes<StringBytesEntropyImpl, N
5454

5555
REGISTER_FUNCTION(StringBytesEntropy)
5656
{
57-
factory.registerFunction<FunctionStringBytesEntropy>(
58-
FunctionDocumentation{.description = R"(Calculates Shannon's entropy of byte distribution in a string.)"});
57+
FunctionDocumentation::Description description = "Calculates Shannon's entropy of byte distribution in a string.";
58+
FunctionDocumentation::Syntax syntax = "stringBytesEntropy(s);";
59+
FunctionDocumentation::Arguments arguments = {
60+
{"s", "The string to analyze. [String](../../sql-reference/data-types/string.md))"}
61+
};
62+
FunctionDocumentation::ReturnedValue returned_value = "The Shannon entropy of the byte distribution. [Float64](../../sql-reference/data-types/float.md).";
63+
FunctionDocumentation::Examples examples = {
64+
{"Example",
65+
"SELECT stringBytesEntropy('Hello, world!');",
66+
"3.180832987205441"}
67+
};
68+
FunctionDocumentation::Category category = FunctionDocumentation::Category::String;
69+
70+
FunctionDocumentation function_documentation = {
71+
.description = description,
72+
.syntax = syntax,
73+
.arguments = arguments,
74+
.returned_value = returned_value,
75+
.examples = examples,
76+
.category = category
77+
};
78+
79+
factory.registerFunction<FunctionStringBytesEntropy>(function_documentation);
5980
}
6081

6182
}

src/Functions/stringBytesUniq.cpp

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,29 @@ using FunctionStringBytesUniq = FunctionStringBytes<StringBytesUniqImpl, NameStr
4545

4646
REGISTER_FUNCTION(StringBytesUniq)
4747
{
48-
factory.registerFunction<FunctionStringBytesUniq>(
49-
FunctionDocumentation{.description = R"(Counts the number of distinct bytes in a string.)"});
48+
FunctionDocumentation::Description description = "Counts the number of distinct bytes in a string.";
49+
FunctionDocumentation::Syntax syntax = "stringBytesUniq(s);";
50+
FunctionDocumentation::Arguments arguments = {
51+
{"s", "The string to analyze. [String](../../sql-reference/data-types/string.md)"}
52+
};
53+
FunctionDocumentation::ReturnedValue returned_value = "The number of distinct bytes in the string. [UInt16](../../sql-reference/data-types/int-uint.md).";
54+
FunctionDocumentation::Examples examples = {
55+
{"Example",
56+
"SELECT stringBytesUniq('Hello, world!');",
57+
"10"}
58+
};
59+
FunctionDocumentation::Category category = FunctionDocumentation::Category::String;
60+
61+
FunctionDocumentation function_documentation = {
62+
.description = description,
63+
.syntax = syntax,
64+
.arguments = arguments,
65+
.returned_value = returned_value,
66+
.examples = examples,
67+
.category = category
68+
};
69+
70+
factory.registerFunction<FunctionStringBytesUniq>(function_documentation);
5071
}
5172

5273
}

0 commit comments

Comments
 (0)