summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Alexsander Silva Dias <michaelalexsander@protonmail.com>2019-04-11 21:48:40 -0300
committerMichael Alexsander Silva Dias <michaelalexsander@protonmail.com>2019-04-11 21:48:40 -0300
commit70499faff80b7213d7344db6128a8dc51634613f (patch)
treefc031270dd230a789994cae1963f7d346c283d48
parentda65d546491f11aebf0427f08c826eea3c9e7efb (diff)
Document String's 'is_valid_filename()'
-rw-r--r--doc/classes/String.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
index c3c4b6f938..0cfa246275 100644
--- a/doc/classes/String.xml
+++ b/doc/classes/String.xml
@@ -432,6 +432,14 @@
Returns [code]true[/code] if this string is a subsequence of the given string, without considering case.
</description>
</method>
+ <method name="is_valid_filename">
+ <return type="bool">
+ </return>
+ <description>
+ Returns [code]true[/code] if this string is free from characters that aren't allowed in file names, those being:
+ [code]: / \ ? * " | % < >[/code]
+ </description>
+ </method>
<method name="is_valid_float">
<return type="bool">
</return>