Re-extracted class docs.

This commit is contained in:
Relintai 2023-12-22 19:49:04 +01:00
parent cd34883d79
commit 0d6f38b317
5 changed files with 82 additions and 40 deletions

View File

@ -38,8 +38,8 @@
<argument index="2" name="userdata" type="Variant" default="null" /> <argument index="2" name="userdata" type="Variant" default="null" />
<argument index="3" name="priority" type="int" enum="Thread.Priority" default="1" /> <argument index="3" name="priority" type="int" enum="Thread.Priority" default="1" />
<description> <description>
Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum. Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum.
Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure. Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure.
</description> </description>
</method> </method>
<method name="wait_to_finish"> <method name="wait_to_finish">

View File

@ -43,34 +43,9 @@
<description> <description>
</description> </description>
</method> </method>
<method name="wwwroot_deregister_file"> <method name="wwwroot_get_file_abspath">
<return type="void" />
<argument index="0" name="file_path" type="String" />
<description>
</description>
</method>
<method name="wwwroot_evaluate_dir">
<return type="void" />
<argument index="0" name="file_path" type="String" />
<argument index="1" name="should_exist " type="bool" default="true" />
<description>
</description>
</method>
<method name="wwwroot_get_file_index">
<return type="int" />
<argument index="0" name="file_path" type="String" />
<description>
</description>
</method>
<method name="wwwroot_get_file_orig_path">
<return type="String" /> <return type="String" />
<argument index="0" name="index" type="int" /> <argument index="0" name="file_path" type="String" />
<description>
</description>
</method>
<method name="wwwroot_get_file_orig_path_abs">
<return type="String" />
<argument index="0" name="index" type="int" />
<description> <description>
</description> </description>
</method> </method>
@ -80,17 +55,6 @@
<description> <description>
</description> </description>
</method> </method>
<method name="wwwroot_refresh_cache">
<return type="void" />
<description>
</description>
</method>
<method name="wwwroot_register_file">
<return type="void" />
<argument index="0" name="file_path" type="String" />
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="cache_invalidation_time" type="int" setter="set_cache_invalidation_time" getter="get_cache_invalidation_time" default="0"> <member name="cache_invalidation_time" type="int" setter="set_cache_invalidation_time" getter="get_cache_invalidation_time" default="0">

View File

@ -24,6 +24,12 @@
The default implementation of stop(). The default implementation of stop().
</description> </description>
</method> </method>
<method name="_unregister_connection_for_request" qualifiers="virtual">
<return type="Dictionary" />
<argument index="0" name="request" type="WebServerRequest" />
<description>
</description>
</method>
<method name="get_session_manager"> <method name="get_session_manager">
<return type="HTTPSessionManager" /> <return type="HTTPSessionManager" />
<description> <description>
@ -63,6 +69,12 @@
Stop the server. Stop the server.
</description> </description>
</method> </method>
<method name="unregister_connection_for_request">
<return type="Dictionary" />
<argument index="0" name="request" type="WebServerRequest" />
<description>
</description>
</method>
</methods> </methods>
<constants> <constants>
<constant name="NOTIFICATION_WEB_SERVER_STARTED" value="2000"> <constant name="NOTIFICATION_WEB_SERVER_STARTED" value="2000">

View File

@ -150,6 +150,22 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_get_parameter_keys" qualifiers="const">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="get_header_parameter" qualifiers="const">
<return type="String" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="get_header_parameter_keys" qualifiers="const">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="get_host" qualifiers="const"> <method name="get_host" qualifiers="const">
<return type="String" /> <return type="String" />
<description> <description>
@ -181,6 +197,11 @@
Returns the value that was set in the request header for the given key, or an empty String. Returns the value that was set in the request header for the given key, or an empty String.
</description> </description>
</method> </method>
<method name="get_parameter_keys" qualifiers="const">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="get_path" qualifiers="const"> <method name="get_path" qualifiers="const">
<return type="String" /> <return type="String" />
<argument index="0" name="beginning_slash" type="bool" default="false" /> <argument index="0" name="beginning_slash" type="bool" default="false" />
@ -214,6 +235,11 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_post_parameter_keys" qualifiers="const">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="get_remaining_segment_count" qualifiers="const"> <method name="get_remaining_segment_count" qualifiers="const">
<return type="int" /> <return type="int" />
<description> <description>
@ -390,6 +416,13 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_header_parameter">
<return type="void" />
<argument index="0" name="key" type="String" />
<argument index="1" name="value" type="String" />
<description>
</description>
</method>
<method name="set_post_parameter"> <method name="set_post_parameter">
<return type="void" /> <return type="void" />
<argument index="0" name="key" type="String" /> <argument index="0" name="key" type="String" />

View File

@ -64,6 +64,22 @@
<description> <description>
</description> </description>
</method> </method>
<method name="_get_get_parameter_keys" qualifiers="virtual">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="_get_header_parameter" qualifiers="virtual">
<return type="void" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="_get_header_parameter_keys" qualifiers="virtual">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="_get_host" qualifiers="virtual"> <method name="_get_host" qualifiers="virtual">
<return type="void" /> <return type="void" />
<description> <description>
@ -80,6 +96,11 @@
<description> <description>
</description> </description>
</method> </method>
<method name="_get_parameter_keys" qualifiers="virtual">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="_get_path_full" qualifiers="virtual"> <method name="_get_path_full" qualifiers="virtual">
<return type="void" /> <return type="void" />
<description> <description>
@ -91,6 +112,11 @@
<description> <description>
</description> </description>
</method> </method>
<method name="_get_post_parameter_keys" qualifiers="virtual">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="_parse_files" qualifiers="virtual"> <method name="_parse_files" qualifiers="virtual">
<return type="void" /> <return type="void" />
<description> <description>
@ -132,6 +158,13 @@
<description> <description>
</description> </description>
</method> </method>
<method name="_set_header_parameter" qualifiers="virtual">
<return type="void" />
<argument index="0" name="key" type="String" />
<argument index="1" name="value" type="String" />
<description>
</description>
</method>
<method name="_set_post_parameter" qualifiers="virtual"> <method name="_set_post_parameter" qualifiers="virtual">
<return type="void" /> <return type="void" />
<argument index="0" name="key" type="String" /> <argument index="0" name="key" type="String" />