Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-11 13:21:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
modules/web/doc_classes/FileCache.xml
View File

@ -43,34 +43,9 @@
<description>
</description>
</method>
<method name="wwwroot_deregister_file">
<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">
<method name="wwwroot_get_file_abspath">
<return type="String" />
<argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="wwwroot_get_file_orig_path_abs">
<return type="String" />
<argument index="0" name="index" type="int" />
<argument index="0" name="file_path" type="String" />
<description>
</description>
</method>
@ -80,17 +55,6 @@
<description>
</description>
</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>
<members>
<member name="cache_invalidation_time" type="int" setter="set_cache_invalidation_time" getter="get_cache_invalidation_time" default="0">

12
modules/web/doc_classes/WebServer.xml
View File

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

33
modules/web/doc_classes/WebServerRequest.xml
View File

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

33
modules/web/doc_classes/WebServerRequestScriptable.xml
View File

@ -64,6 +64,22 @@
<description>
</description>
</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">
<return type="void" />
<description>
@ -80,6 +96,11 @@
<description>
</description>
</method>
<method name="_get_parameter_keys" qualifiers="virtual">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="_get_path_full" qualifiers="virtual">
<return type="void" />
<description>
@ -91,6 +112,11 @@
<description>
</description>
</method>
<method name="_get_post_parameter_keys" qualifiers="virtual">
<return type="PoolStringArray" />
<description>
</description>
</method>
<method name="_parse_files" qualifiers="virtual">
<return type="void" />
<description>
@ -132,6 +158,13 @@
<description>
</description>
</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">
<return type="void" />
<argument index="0" name="key" type="String" />