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 2022-12-22 19:28:17 +01:00
parent 09ad2db471
commit cc7d77f3e1
12 changed files with 172 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
editor_modules/gltf/doc_classes/GLTFDocumentExtension.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFDocumentExtension" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="GLTFDocumentExtension" inherits="Resource" version="3.10">
<brief_description>
[GLTFDocument] extension class.
</brief_description>

2
modules/database/doc_classes/TableBuilder.xml
View File

@ -61,7 +61,7 @@
<method name="integer">
<return type="TableBuilder" />
<argument index="0" name="name" type="String" />
<argument index="1" name="length" type="int" />
<argument index="1" name="length" type="int" default="-1" />
<description>
</description>
</method>

8
modules/users/doc_classes/UserDeleteWebPage.xml
View File

@ -8,6 +8,14 @@
</tutorials>
<methods>
</methods>
<signals>
<signal name="user_deleted">
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="user" type="User" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

8
modules/users/doc_classes/UserLoginWebPage.xml
View File

@ -14,6 +14,14 @@
<member name="redirect_on_success_url" type="String" setter="set_redirect_on_success_url" getter="get_redirect_on_success_url" default="&quot;&quot;">
</member>
</members>
<signals>
<signal name="user_logged_in">
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="user" type="User" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

8
modules/users/doc_classes/UserLogoutWebPage.xml
View File

@ -8,6 +8,14 @@
</tutorials>
<methods>
</methods>
<signals>
<signal name="user_logged_out">
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="user" type="User" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

8
modules/users/doc_classes/UserPasswordResetWebPage.xml
View File

@ -8,6 +8,14 @@
</tutorials>
<methods>
</methods>
<signals>
<signal name="user_password_reseted">
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="user" type="User" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

8
modules/users/doc_classes/UserRegisterWebPage.xml
View File

@ -14,6 +14,14 @@
<member name="redirect_on_success_url" type="String" setter="set_redirect_on_success_url" getter="get_redirect_on_success_url" default="&quot;&quot;">
</member>
</members>
<signals>
<signal name="user_registered">
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="user" type="User" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

8
modules/users/doc_classes/UserSettingsWebPage.xml
View File

@ -8,6 +8,14 @@
</tutorials>
<methods>
</methods>
<signals>
<signal name="user_settings_changed">
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="user" type="User" />
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>

13
modules/web/doc_classes/HTMLBuilder.xml
View File

@ -679,6 +679,12 @@
<description>
</description>
</method>
<method name="ctag">
<return type="_HTMLBuilder" />
<argument index="0" name="tag" type="String" />
<description>
</description>
</method>
<method name="ctbody">
<return type="_HTMLBuilder" />
<description>
@ -1478,6 +1484,13 @@
<description>
</description>
</method>
<method name="tag">
<return type="_HTMLTag" />
<argument index="0" name="tag" type="String" />
<argument index="1" name="simple" type="bool" default="false" />
<description>
</description>
</method>
<method name="tbody">
<return type="_HTMLTag" />
<description>

2
modules/web/doc_classes/HTTPSessionManager.xml
View File

@ -30,7 +30,7 @@
</description>
</method>
<method name="delete_session">
<return type="void" />
<return type="HTTPSession" />
<argument index="0" name="session_id" type="String" />
<description>
</description>

96
modules/web/doc_classes/HTTPSessionManagerDB.xml Normal file
View File

@ -0,0 +1,96 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="HTTPSessionManagerDB" inherits="HTTPSessionManager" version="3.10">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_create_default_entries" qualifiers="virtual">
<return type="void" />
<argument index="0" name="pseed" type="int" />
<description>
</description>
</method>
<method name="_create_table" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_drop_table" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_migrate" qualifiers="virtual">
<return type="void" />
<argument index="0" name="clear" type="bool" />
<argument index="1" name="should_seed" type="bool" />
<argument index="2" name="pseed" type="int" />
<description>
</description>
</method>
<method name="_udpate_table" qualifiers="virtual">
<return type="void" />
<argument index="0" name="current_table_version" type="int" />
<description>
</description>
</method>
<method name="create_default_entries">
<return type="void" />
<argument index="0" name="pseed" type="int" />
<description>
</description>
</method>
<method name="create_table">
<return type="void" />
<description>
</description>
</method>
<method name="drop_table">
<return type="void" />
<description>
</description>
</method>
<method name="get_database_connection">
<return type="DatabaseConnection" />
<description>
</description>
</method>
<method name="get_query_builder">
<return type="QueryBuilder" />
<description>
</description>
</method>
<method name="get_table_builder">
<return type="TableBuilder" />
<description>
</description>
</method>
<method name="migrate">
<return type="void" />
<argument index="0" name="clear" type="bool" />
<argument index="1" name="pseed" type="bool" />
<argument index="2" name="arg2" type="int" />
<description>
</description>
</method>
<method name="udpate_table">
<return type="void" />
<argument index="0" name="current_table_version" type="int" />
<description>
</description>
</method>
</methods>
<members>
<member name="database" type="Database" setter="set_database" getter="get_database">
</member>
<member name="database_data_table_name" type="String" setter="set_database_data_table_name" getter="get_database_data_table_name" default="&quot;http_session_data&quot;">
</member>
<member name="database_table_name" type="String" setter="set_database_table_name" getter="get_database_table_name" default="&quot;http_sessions&quot;">
</member>
</members>
<constants>
</constants>
</class>

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

@ -115,6 +115,12 @@
Returns the file's length.
</description>
</method>
<method name="get_get_parameter" qualifiers="const">
<return type="String" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="get_host" qualifiers="const">
<return type="String" />
<description>
@ -173,6 +179,12 @@
Reutrns how many path segments a request has.
</description>
</method>
<method name="get_post_parameter" qualifiers="const">
<return type="String" />
<argument index="0" name="key" type="String" />
<description>
</description>
</method>
<method name="get_remaining_segment_count" qualifiers="const">
<return type="int" />
<description>