From b5924d769d2677fbd9b3502cea26ec0dad107c2b Mon Sep 17 00:00:00 2001 From: Quin Date: Tue, 5 Nov 2024 03:45:16 -0700 Subject: [PATCH] Genneral documentation work Make many function signatures in the docs better match how they were registered. other doc cleanup, such as giving c_debug_message's parameter a datatype. --- .../Classes/json_object/Methods/exists.nvgt | 4 ++-- .../Classes/json_object/Methods/remove.nvgt | 4 ++-- .../Classes/json_object/Methods/set.nvgt | 4 ++-- .../Classes/json_object/Operators/get_opIndex.nvgt | 4 ++-- .../Classes/json_object/Operators/opCall.nvgt | 4 ++-- .../Classes/json_object/Operators/set_opIndex.nvgt | 4 ++-- .../Data Manipulation/Classes/pack/methods/add_file.md | 6 +++--- .../Data Manipulation/Classes/pack/methods/add_memory.md | 6 +++--- .../Data Manipulation/Classes/pack/methods/delete_file.md | 4 ++-- .../Data Manipulation/Classes/pack/methods/file_exists.md | 4 ++-- .../Classes/pack/methods/get_file_offset.md | 4 ++-- .../Classes/pack/methods/get_file_size.md | 4 ++-- .../Data Manipulation/Classes/pack/methods/open.md | 4 ++-- .../Data Manipulation/Classes/pack/methods/read_file.md | 4 ++-- .../Classes/pack/methods/set_pack_identifier.md | 4 ++-- .../builtin/Data Manipulation/Classes/regexp/!regexp.nvgt | 4 ++-- .../Data Manipulation/Classes/regexp/methods/match.md | 8 ++++---- .../Data Manipulation/Functions/character_to_ascii.nvgt | 4 ++-- .../builtin/Data Manipulation/Functions/join.nvgt | 6 +++--- .../Functions/pack_set_global_identifier.md | 4 ++-- .../builtin/Data Manipulation/Functions/regexp_match.nvgt | 6 +++--- .../Data Manipulation/Functions/string_base32_decode.nvgt | 4 ++-- .../Data Manipulation/Functions/string_base32_encode.nvgt | 4 ++-- .../Functions/string_base32_normalize.nvgt | 4 ++-- .../Data Manipulation/Functions/string_base64_decode.nvgt | 4 ++-- .../Data Manipulation/Functions/string_base64_encode.nvgt | 4 ++-- .../Functions/c_debug_message.nvgt | 4 ++-- .../builtin/Profiling and Debugging/Functions/throw.nvgt | 4 ++-- .../Text-To-Speech/Functions/screen_reader_braille.nvgt | 4 ++-- .../Text-To-Speech/Functions/screen_reader_output.nvgt | 4 ++-- .../Text-To-Speech/Functions/screen_reader_speak.nvgt | 4 ++-- .../Text-To-Speech/classes/tts_voice/Methods/speak.nvgt | 4 ++-- .../classes/tts_voice/Methods/speak_interrupt.nvgt | 4 ++-- .../classes/tts_voice/Methods/speak_to_file.nvgt | 6 +++--- .../Functions/android_request_permission.md | 1 - .../User Interface/Functions/android_show_toast.md | 5 ++--- 36 files changed, 77 insertions(+), 79 deletions(-) diff --git a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/exists.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/exists.nvgt index 9d131e46..15ec7cdb 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/exists.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/exists.nvgt @@ -1,8 +1,8 @@ /** Determine if a key exists in the JSON object. - bool json_object::exists(string key); + bool json_object::exists(const string?&in key); ## Arguments: - * string: the key to search for. + * const string&in key: the key to search for. ## Returns: bool: true if the key exists, false if not. */ diff --git a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/remove.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/remove.nvgt index ae1403f0..4fa9cbb5 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/remove.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/remove.nvgt @@ -1,8 +1,8 @@ /** Remove a value from the JSON object given a key. - void json_object::remove(string key); + void json_object::remove(const string&in key); ## Arguments: - * string key: the key of the value to remove. + * const string&in key: the key of the value to remove. */ // Example: diff --git a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/set.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/set.nvgt index e8796423..35a24b34 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/set.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Methods/set.nvgt @@ -1,8 +1,8 @@ /** Set a value in a JSON object. - void json_object::set(string key, var@ value); + void json_object::set(const string&in key, var@ value); ## Arguments: - * string key: the key to give the value. + * const string&in key: the key to give the value. * var@ value: a handle to the value to be set. */ diff --git a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/get_opIndex.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/get_opIndex.nvgt index 19afed23..9a50acce 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/get_opIndex.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/get_opIndex.nvgt @@ -1,8 +1,8 @@ /** Get a value out of the JSON object with literal syntax, for example `json["key"]`. - var@ json_object::get_opIndex(string key) property; + var@ json_object::get_opIndex(const string&in key) property; ## Arguments: - * string key: the key of the object to get. + * const string&in key: the key of the object to get. ## Returns: var@: a handle to the object, or null if not found. */ diff --git a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/opCall.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/opCall.nvgt index 26869286..c45559db 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/opCall.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/opCall.nvgt @@ -1,8 +1,8 @@ /** Get a value out of a JSON object using a query. - var@ json_object::opCall(string query); + var@ json_object::opCall(const string&in query); ## Arguments: - * string query: the JSON query (see the remarks section for details). + * const string&in query: the JSON query (see the remarks section for details). ## Returns: var@: a handle to the object, null if not found. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/set_opIndex.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/set_opIndex.nvgt index 8bb7cf9d..a53bd328 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/set_opIndex.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/json_object/Operators/set_opIndex.nvgt @@ -1,8 +1,8 @@ /** Set a value in the JSON object with a particular key. - void json_object::set_opIndex(string key, var@ value) property; + void json_object::set_opIndex(const string&in key, var@ value) property; ## Arguments: - * string key: the key of the object. + * const string&in key: the key of the object. * var@ value: the value to set. */ diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_file.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_file.md index 887c9553..a7eea2e6 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_file.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_file.md @@ -1,11 +1,11 @@ # add_file Add a file on disk to a pack. -`bool pack::add_file(string disk_filename, string pack_filename, bool allow_replace = false);` +`bool pack::add_file(const string&in disk_filename, const string&in pack_filename, bool allow_replace = false);` ## Arguments: -* string disk_filename: the filename of the file to add to the pack. -* string pack_filename: the name the file should have in your pack. +* const string&in disk_filename: the filename of the file to add to the pack. +* const string&in pack_filename: the name the file should have in your pack. * bool allow_replace = false: if a file already exists in the pack with that name, should it be overwritten? ## Returns: diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_memory.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_memory.md index 6cac1a59..08607b80 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_memory.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/add_memory.md @@ -1,11 +1,11 @@ # add_memory Add content stored in memory to a pack. -`bool pack::add_memory(string pack_filename, string data, bool replace = false);` +`bool pack::add_memory(const string&in pack_filename, const string&in data, bool replace = false);` ## Arguments: -* string pack_filename: the name the file should have in your pack. -* string data: a string containing the data to be added. +* const string&in pack_filename: the name the file should have in your pack. +* const string&in data: a string containing the data to be added. * bool allow_replace = false: if a file already exists in the pack with that name, should it be overwritten? ## Returns: diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/delete_file.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/delete_file.md index 179d0f44..87df31cb 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/delete_file.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/delete_file.md @@ -1,10 +1,10 @@ # delete_file Attempt to remove a file from a pack. -`bool pack::delete_file(string filename);` +`bool pack::delete_file(const string&in filename);` ## Arguments: -* string filename: the name of the file to be deleted. +* const string&in filename: the name of the file to be deleted. ## Returns: bool: true if the file was successfully deleted, false otherwise. diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/file_exists.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/file_exists.md index 0aa2894f..e37e2e60 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/file_exists.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/file_exists.md @@ -1,10 +1,10 @@ # file_exists Query whether or not a file exists in your pack. -`bool pack::file_exists(string filename);` +`bool pack::file_exists(const string&in filename);` ## Arguments: -* string filename: the name of the file to query. +* const string&in filename: the name of the file to query. ## Returns: bool: true if the file exists in the pack, false if not. diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_offset.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_offset.md index 5f72655f..bfc42282 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_offset.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_offset.md @@ -1,10 +1,10 @@ # get_file_offset Get the offset of a file in your pack. -`uint pack::get_file_offset(string filename);` +`uint pack::get_file_offset(const string&in filename);` ## Arguments: -* string filename: the name of the file to get the offset of. +* const string&in filename: the name of the file to get the offset of. ## Returns: uint: the offset of the file (in bytes). diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_size.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_size.md index b380f257..fdbd6e1a 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_size.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/get_file_size.md @@ -1,10 +1,10 @@ # get_file_size Returns the size of a particula file in the pack. -`uint pack::get_file_size(string filename);` +`uint pack::get_file_size(const string&in filename);` ## Arguments: -* string filename: the name of the file to query the size of. +* const string&in filename: the name of the file to query the size of. ## Returns: uint: the size of the file (in bytes), or 0 if no file with that name was found. diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/open.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/open.md index 77f4a48c..95cb15b4 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/open.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/open.md @@ -1,10 +1,10 @@ # open Open a pack to perform operations on it. -`bool pack::open(string filename, uint mode, bool memload = false);` +`bool pack::open(const string&in filename, uint mode, bool memload = false);` ## Arguments: -* string filename: the name of the pack file to open. +* const string&in filename: the name of the pack file to open. * uint mode: the mode to open the pack in (see `pack_open_modes` for more information). * bool memload = false: whether or not the pack should be loaded from memory as opposed to on disk. diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/read_file.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/read_file.md index e2cb760b..82dc2a81 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/read_file.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/read_file.md @@ -1,10 +1,10 @@ # read_file Get the contents of a file contained in a pack. -`string pack::read_file(string pack_filename, uint offset_in_file, uint size);` +`string pack::read_file(const string&in pack_filename, uint offset_in_file, uint size);` ## Arguments: -* string pack_filename: the name of the file to be read. +* const string&in pack_filename: the name of the file to be read. * uint offset_in_file: the offset within the file to begin reading data from (do not confuse this with pack::get_file_offset) * uint size: the number of bytes to read (see `pack::get_file_size` to read the entire file). diff --git a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/set_pack_identifier.md b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/set_pack_identifier.md index 7716f368..1e7b3a80 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/set_pack_identifier.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/pack/methods/set_pack_identifier.md @@ -1,10 +1,10 @@ # set_pack_identifier Set the identifier of this pack object (e.g. the first 8-bytes that determine if you have a valid pack or not). -`bool pack::set_pack_identifier(string ident);` +`bool pack::set_pack_identifier(const string&in ident);` ## Arguments: -* string ident: the new identifier (see remarks). +* const string&in ident: the new identifier (see remarks). ## Returns: bool: true if the pack's identifier was properly set, false otherwise. diff --git a/doc/src/references/builtin/Data Manipulation/Classes/regexp/!regexp.nvgt b/doc/src/references/builtin/Data Manipulation/Classes/regexp/!regexp.nvgt index deb2fcf8..25bdc47a 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/regexp/!regexp.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Classes/regexp/!regexp.nvgt @@ -1,8 +1,8 @@ /** The regexp object allows for the easy usage of regular expressions in NVGT. - regexp(string pattern, int options = RE_UTF8); + regexp(const string&in pattern, int options = RE_UTF8); ## Arguments: - * string pattern: the regular expression's pattern (see remarks). + * const string&in pattern: the regular expression's pattern (see remarks). * int options = RE_UTF8: a combination of any of the values from the `regexp_options` enum. ## Remarks: Regular expressions are a language used for matching, substituting, and otherwise manipulating text. To learn about the regular expression syntax that nVGT uses (called PCRE), see this link: https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions diff --git a/doc/src/references/builtin/Data Manipulation/Classes/regexp/methods/match.md b/doc/src/references/builtin/Data Manipulation/Classes/regexp/methods/match.md index 2d0c4167..b04b1932 100644 --- a/doc/src/references/builtin/Data Manipulation/Classes/regexp/methods/match.md +++ b/doc/src/references/builtin/Data Manipulation/Classes/regexp/methods/match.md @@ -1,15 +1,15 @@ # match Determine if the regular expression matches against a particular string or not. -1. `bool regexp::match(string subject, uint64 offset = 0);` -2. `bool regexp::match(string subject, uint64 offset, int options);` +1. `bool regexp::match(const string&in subject, uint64 offset = 0);` +2. `bool regexp::match(const string&in subject, uint64 offset, int options);` ## Arguments (1): -* string subject: the string to compare against. +* const string&in subject: the string to compare against. * uint64 offset = 0: the offset to start the comparison at. ## Arguments (2): -* string subject: the string to compare against. +* const string&in subject: the string to compare against. * uint64 offset: the offset to start the comparison at. * int options: any combination of the values found in the `regexp_options` enum. diff --git a/doc/src/references/builtin/Data Manipulation/Functions/character_to_ascii.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/character_to_ascii.nvgt index 7a113798..c8fcb948 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/character_to_ascii.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/character_to_ascii.nvgt @@ -1,8 +1,8 @@ /** Return the ascii value for the given character. - uint8 character_to_ascii(string character); + uint8 character_to_ascii(const string&in character); ## Arguments: - * string character: the character to convert. + * const string&in character: the character to convert. ## Returns: uint8: the ascii value for the given character. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Functions/join.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/join.nvgt index bd76fe4f..55ba0361 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/join.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/join.nvgt @@ -1,9 +1,9 @@ /** turn an array into a string, with each element being separated by the given delimiter. - string join(string[] elements, string delimiter); + string join(const string[]@ elements, const string&in delimiter); ## Arguments: - * string[] elements: the array to join. - * string delimiter: the delimiter used to separate each element in the array (can be empty). + * const string[]@ elements: a handle to the array to join. + * const string&in delimiter: the delimiter used to separate each element in the array (can be empty). ## Returns: string: the given array as a string. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Functions/pack_set_global_identifier.md b/doc/src/references/builtin/Data Manipulation/Functions/pack_set_global_identifier.md index 5a7c544e..2715aebd 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/pack_set_global_identifier.md +++ b/doc/src/references/builtin/Data Manipulation/Functions/pack_set_global_identifier.md @@ -1,10 +1,10 @@ # pack_set_global_identifier Set the global identifier of all your packs (e.g. the first 8-bytes that determine if you have a valid pack or not). -`bool pack_set_global_identifier(string ident);` +`bool pack_set_global_identifier(const string&in ident);` ## Arguments: -* string ident: the new identifier (see remarks). +* const string&in ident: the new identifier (see remarks). ## Returns: bool: true if the identifier was properly set, false otherwise. diff --git a/doc/src/references/builtin/Data Manipulation/Functions/regexp_match.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/regexp_match.nvgt index 52a394a6..6ba489bb 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/regexp_match.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/regexp_match.nvgt @@ -1,9 +1,9 @@ /** Test if the text matches the specified regular expression. - bool regexp_match(string text, string pattern); + bool regexp_match(const string&in text, const string&in pattern); ## Arguments: - * string text: the text to compare against the regular expression. - * string pattern: the regular expression to match. + * const string&in text: the text to compare against the regular expression. + * const string&in pattern: the regular expression to match. ## Returns: bool: true if the text matches the given regular expression, false otherwise. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Functions/string_base32_decode.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/string_base32_decode.nvgt index c5e9114f..246e4908 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/string_base32_decode.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/string_base32_decode.nvgt @@ -1,8 +1,8 @@ /** Decodes a string from base32. - string string_base32_decode(string the_data); + string string_base32_decode(const string&in the_data); ## Arguments: - * string the_data: The data that is to be decoded. + * const string&in the_data: The data that is to be decoded. ## Returns: String: The decoded string on success or an empty string on failure. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Functions/string_base32_encode.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/string_base32_encode.nvgt index e0640300..55546dcb 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/string_base32_encode.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/string_base32_encode.nvgt @@ -1,8 +1,8 @@ /** Encodes a string as base32. - string string_base32_encode(string the_data); + string string_base32_encode(const string&in the_data); ## Arguments: - * string the_data: The data that is to be encoded. + * const string&in the_data: The data that is to be encoded. ## Returns: String: The encoded string on success or an empty string on failure. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Functions/string_base32_normalize.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/string_base32_normalize.nvgt index 06ab7a5f..2355fbf0 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/string_base32_normalize.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/string_base32_normalize.nvgt @@ -1,8 +1,8 @@ /** Normalize a string to conform to the base32 spec. - string string_base32_normalize(string the_data); + string string_base32_normalize(const string&in the_data); ## Arguments: - * string the_data: the string to normalize. + * const string&in the_data: the string to normalize. ## Returns: string: the normalized string. ## Remarks: diff --git a/doc/src/references/builtin/Data Manipulation/Functions/string_base64_decode.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/string_base64_decode.nvgt index 2b1b3ca4..31b182ca 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/string_base64_decode.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/string_base64_decode.nvgt @@ -1,8 +1,8 @@ /** Decodes a string which has previously been encoded in base64. - string string_base64_decode(string the_data, string_base64_options options = STRING_BASE64_PADLESS); + string string_base64_decode(const string&in the_data, string_base64_options options = STRING_BASE64_PADLESS); ## Arguments: - * string the_data: The data that is to be decoded. + * const string&in the_data: The data that is to be decoded. * string_base64_options options = STRING_BASE64_PADLESS: A bitwise of options that control the behavior of the decoding (see remarks). ## Returns: String: The decoded string on success or an empty string on failure. diff --git a/doc/src/references/builtin/Data Manipulation/Functions/string_base64_encode.nvgt b/doc/src/references/builtin/Data Manipulation/Functions/string_base64_encode.nvgt index c03cff85..ed715eb2 100644 --- a/doc/src/references/builtin/Data Manipulation/Functions/string_base64_encode.nvgt +++ b/doc/src/references/builtin/Data Manipulation/Functions/string_base64_encode.nvgt @@ -1,8 +1,8 @@ /** Encodes a string as base64. - string string_base64_encode(string the_data, string_base64_options options = STRING_BASE64_DEFAULT); + string string_base64_encode(const string&in the_data, string_base64_options options = STRING_BASE64_DEFAULT); ## Arguments: - * string the_data: The data that is to be encoded. + * const string&in the_data: The data that is to be encoded. * string_base64_options options = STRING_BASE64_DEFAULT: A bitwise of options that control the behavior of the encoding (see remarks). ## Returns: String: The encoded string on success or an empty string on failure. diff --git a/doc/src/references/builtin/Profiling and Debugging/Functions/c_debug_message.nvgt b/doc/src/references/builtin/Profiling and Debugging/Functions/c_debug_message.nvgt index eb7027e0..e183e47d 100644 --- a/doc/src/references/builtin/Profiling and Debugging/Functions/c_debug_message.nvgt +++ b/doc/src/references/builtin/Profiling and Debugging/Functions/c_debug_message.nvgt @@ -1,8 +1,8 @@ /** Print a message to the C debugger. - void c_debug_message(string message); + void c_debug_message(const string&in message); ## Arguments: - * Message: The message to print to the C debugger's console. + * const string&in message: The message to print to the C debugger's console. */ // Example: diff --git a/doc/src/references/builtin/Profiling and Debugging/Functions/throw.nvgt b/doc/src/references/builtin/Profiling and Debugging/Functions/throw.nvgt index 029087ff..92097389 100644 --- a/doc/src/references/builtin/Profiling and Debugging/Functions/throw.nvgt +++ b/doc/src/references/builtin/Profiling and Debugging/Functions/throw.nvgt @@ -1,8 +1,8 @@ /** Throws an exception with a particular message. - void throw(string msg); + void throw(const string&in msg); ## Arguments: - * string msg: the message to include in your exception. + * const string&in msg: the message to include in your exception. ## Remarks: This is presently slightly limited, the only value of the exception you can set is the message. There are plans to expand this in the future. */ diff --git a/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_braille.nvgt b/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_braille.nvgt index 35a1c852..3523af3c 100644 --- a/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_braille.nvgt +++ b/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_braille.nvgt @@ -1,8 +1,8 @@ /** Brailles a string through the currently active screen reader, if supported. - bool screen_reader_braille(string text); + bool screen_reader_braille(const string&in text); ## Arguments: - * string text: the text to braille. + * const string&in text: the text to braille. ## Returns: bool: true if the function succeeded, false otherwise. */ diff --git a/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_output.nvgt b/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_output.nvgt index 5f15d146..34f0f962 100644 --- a/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_output.nvgt +++ b/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_output.nvgt @@ -1,8 +1,8 @@ /** Speaks and brailles a string through the currently active screen reader, if supported. - bool screen_reader_output(string text, bool interrupt = true); + bool screen_reader_output(const string&in text, bool interrupt = true); ## Arguments: - * string text: the text to output. + * const string&in text: the text to output. * bool interrupt = true: Whether or not the previously spoken speech should be interrupted or not when speaking the new string. ## Returns: bool: true if the function succeeded, false otherwise. diff --git a/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_speak.nvgt b/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_speak.nvgt index 5054d879..b4f5ae20 100644 --- a/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_speak.nvgt +++ b/doc/src/references/builtin/Text-To-Speech/Functions/screen_reader_speak.nvgt @@ -1,8 +1,8 @@ /** Speaks a string through the currently active screen reader, if supported. - bool screen_reader_speak(string text, bool interrupt = true); + bool screen_reader_speak(const string&in text, bool interrupt = true); ## Arguments: - * string text: the text to speak. + * const string&in text: the text to speak. * bool interrupt = true: Whether or not the previously spoken speech should be interrupted or not when speaking the new string. ## Returns: bool: true if the function succeeded, false otherwise. diff --git a/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak.nvgt b/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak.nvgt index b88db757..c5ce322a 100644 --- a/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak.nvgt +++ b/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak.nvgt @@ -1,8 +1,8 @@ /** Speak a string of text through the currently active TTS voice. - bool tts_voice::speak(string text, bool interrupt = false); + bool tts_voice::speak(const string &in text, bool interrupt = false); ## Arguments: - * string text: the text to be spoken. + * const string&in text: the text to be spoken. * bool interrupt = false: whether or not to interrupt the previously speaking speech to speak the new string. ## Returns: bool: true if speech was successful, false otherwise. diff --git a/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_interrupt.nvgt b/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_interrupt.nvgt index b061d6cb..3e6dee82 100644 --- a/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_interrupt.nvgt +++ b/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_interrupt.nvgt @@ -1,8 +1,8 @@ /** Speaks a string (forcefully interrupting) through the currently active text-to-speech voice. - bool tts_voice::speak_interrupt(string text); + bool tts_voice::speak_interrupt(const string&in text); ## Arguments: - * string text: the text to speak. + * const string&in text: the text to speak. ## Returns: bool: true if the speech was generated successfully, false otherwise. */ diff --git a/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_to_file.nvgt b/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_to_file.nvgt index ed4954ca..3c7d4f7f 100644 --- a/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_to_file.nvgt +++ b/doc/src/references/builtin/Text-To-Speech/classes/tts_voice/Methods/speak_to_file.nvgt @@ -1,9 +1,9 @@ /** Outputs a string of text through the currently active TTS voice to a wave file. - bool tts_voice::speak_to_file(string filename, string text); + bool tts_voice::speak_to_file(const string&in filename, const string&in text); ## Arguments: - * string filename: the filename to write to. - * string text: the text to synthesize. + * const string&in filename: the filename to write to. + * const string&in text: the text to synthesize. ## Returns: bool: true if synthesis was successful and the file was written, false otherwise. */ diff --git a/doc/src/references/builtin/User Interface/Functions/android_request_permission.md b/doc/src/references/builtin/User Interface/Functions/android_request_permission.md index e8c4fb2e..bbc7a46d 100644 --- a/doc/src/references/builtin/User Interface/Functions/android_request_permission.md +++ b/doc/src/references/builtin/User Interface/Functions/android_request_permission.md @@ -1,5 +1,4 @@ # android_request_permission - Request a permission from the Android operating system either synchronously or asynchronously. `bool android_request_permission(string permission, android_permission_request_callback@ callback = null, string callback_data = "");` diff --git a/doc/src/references/builtin/User Interface/Functions/android_show_toast.md b/doc/src/references/builtin/User Interface/Functions/android_show_toast.md index 968cd052..fab32bfb 100644 --- a/doc/src/references/builtin/User Interface/Functions/android_show_toast.md +++ b/doc/src/references/builtin/User Interface/Functions/android_show_toast.md @@ -1,11 +1,10 @@ # android_show_toast - Shows an Android toast notification, small popups that are unique to that operating system. -`bool android_show_toast(string message, int duration, int gravity = -1, int x_offset = 0, int y_offset = 0);` +`bool android_show_toast(const string&in message, int duration, int gravity = -1, int x_offset = 0, int y_offset = 0);` ## Arguments: -* string message: The message to display. +* const string&in message: The message to display. * int duration: 0 for short or 1 for long, all other values are undefined. * int gravity = -1: One of [the values on this page](https://developer.android.com/reference/android/view/Gravity) or -1 for no preference. * int x_offset = 0, int y_offset = 0: Only used if gravity is set, see Android developer documentation.