doc update

This commit is contained in:
udo
2022-04-18 23:37:21 +00:00
parent defc628204
commit 364d83b199
17 changed files with 482 additions and 120 deletions
+23
View File
@@ -0,0 +1,23 @@
:sig
DTree* call_file(String file_name, String function_name, DTree* call_param = null)
:params
file_name : UCE file to load and execute
function_name : name of the function to invoke
call_param : optional, call parameter
return value : DTree* returned from function
:desc
Calls a function inside a UCE file.
:Example
// export a function
EXPORT void test_func()
{
print("HELLO FROM TEST FUNCTION");
}
// use that function in another file
call_file("call_file_funcs.uce", "test_func");
:see
>ob
+11
View File
@@ -0,0 +1,11 @@
:sig
String concat(...vals)
:params
...val : one or more values that should be concatenated
:desc
Returns a string with all the parameters concatenated into one.
:see
>string
@@ -7,3 +7,5 @@ file name : name of an UCE file that should be included
:desc
Includes another UCE file
:see
>ob
+2 -1
View File
@@ -7,4 +7,5 @@ void print(...val)
:desc
Appends data to the current request's output stream.
:see
>string
+16
View File
@@ -0,0 +1,16 @@
:sig
void render_file(String file_name, DTree& call_param = null)
:params
file_name : UCE file to load and execute
call_param : optional, call parameter
:desc
Calls another UCE file and executes its RENDER() function.
:Example
// call a common page template
render_file("page-template.uce");
:see
>ob