From 35e328576ae00db954204164aea41e5106c6d3e7 Mon Sep 17 00:00:00 2001
From: Relintai <relintai@protonmail.com>
Date: Sun, 25 Feb 2024 19:17:06 +0100
Subject: [PATCH] Set up docs for the new classes.

---
 modules/web/config.py                        |   3 +
 modules/web/doc_classes/HTMLTemplate.xml     | 159 +++++++++++++++++++
 modules/web/doc_classes/HTMLTemplateData.xml |  70 ++++++++
 3 files changed, 232 insertions(+)
 create mode 100644 modules/web/doc_classes/HTMLTemplate.xml
 create mode 100644 modules/web/doc_classes/HTMLTemplateData.xml

diff --git a/modules/web/config.py b/modules/web/config.py
index 20e611d88..afe39e8a1 100644
--- a/modules/web/config.py
+++ b/modules/web/config.py
@@ -54,6 +54,9 @@ def get_doc_classes():
 	    "HTMLParserAttribute",
 	    "HTMLParserTag",
 	    "HTMLParser",
+	    
+	    "HTMLTemplate",
+	    "HTMLTemplateData",
 
     	"BBCodeParserAttribute",
 	    "BBCodeParserTag",
diff --git a/modules/web/doc_classes/HTMLTemplate.xml b/modules/web/doc_classes/HTMLTemplate.xml
new file mode 100644
index 000000000..ae3d7da1c
--- /dev/null
+++ b/modules/web/doc_classes/HTMLTemplate.xml
@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="HTMLTemplate" inherits="Resource" version="4.3">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="_render" qualifiers="virtual">
+			<return type="void" />
+			<argument index="0" name="request" type="WebServerRequest" />
+			<argument index="1" name="data" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="add_template">
+			<return type="void" />
+			<argument index="0" name="template" type="HTMLTemplateData" />
+			<description>
+			</description>
+		</method>
+		<method name="clear_template_defaults">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="clear_template_overrides">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="clear_templates">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="get_and_render_template">
+			<return type="String" />
+			<argument index="0" name="name" type="StringName" />
+			<argument index="1" name="request" type="WebServerRequest" />
+			<argument index="2" name="data" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="get_template">
+			<return type="HTMLTemplateData" />
+			<argument index="0" name="index" type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="get_template_count" qualifiers="const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="get_template_default" qualifiers="const">
+			<return type="String" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="get_template_override" qualifiers="const">
+			<return type="String" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="get_template_text">
+			<return type="String" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="has_template_default" qualifiers="const">
+			<return type="bool" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="has_template_override" qualifiers="const">
+			<return type="bool" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="remove_template">
+			<return type="void" />
+			<argument index="0" name="index" type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="remove_template_default">
+			<return type="void" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="remove_template_override">
+			<return type="void" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="render">
+			<return type="String" />
+			<argument index="0" name="request" type="WebServerRequest" />
+			<argument index="1" name="data" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="render_template">
+			<return type="String" />
+			<argument index="0" name="text" type="String" />
+			<argument index="1" name="request" type="WebServerRequest" />
+			<argument index="2" name="data" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="set_template_default">
+			<return type="void" />
+			<argument index="0" name="name" type="StringName" />
+			<argument index="1" name="value" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="set_template_override">
+			<return type="void" />
+			<argument index="0" name="name" type="StringName" />
+			<argument index="1" name="value" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="substitute_data_variables">
+			<return type="String" />
+			<argument index="0" name="text" type="String" />
+			<argument index="1" name="data" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="substitute_request_variables">
+			<return type="String" />
+			<argument index="0" name="text" type="String" />
+			<argument index="1" name="request" type="WebServerRequest" />
+			<description>
+			</description>
+		</method>
+	</methods>
+	<members>
+		<member name="template_defaults" type="Dictionary" setter="set_template_defaults" getter="get_template_defaults" default="{}">
+		</member>
+		<member name="template_overrides" type="Dictionary" setter="set_template_overrides" getter="get_template_overrides" default="{}">
+		</member>
+		<member name="templates" type="Array" setter="set_templates" getter="get_templates" default="[  ]">
+		</member>
+	</members>
+	<constants>
+	</constants>
+</class>
diff --git a/modules/web/doc_classes/HTMLTemplateData.xml b/modules/web/doc_classes/HTMLTemplateData.xml
new file mode 100644
index 000000000..4b07ed89d
--- /dev/null
+++ b/modules/web/doc_classes/HTMLTemplateData.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="HTMLTemplateData" inherits="Resource" version="4.3">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="clear">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="get_template" qualifiers="const">
+			<return type="String" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="has_template" qualifiers="const">
+			<return type="bool" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="load_from_file">
+			<return type="int" enum="Error" />
+			<argument index="0" name="file" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="load_from_string">
+			<return type="void" />
+			<argument index="0" name="data" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="remove_template">
+			<return type="void" />
+			<argument index="0" name="name" type="StringName" />
+			<description>
+			</description>
+		</method>
+		<method name="save_as_string" qualifiers="const">
+			<return type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="save_to_file" qualifiers="const">
+			<return type="int" enum="Error" />
+			<argument index="0" name="file" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="set_template">
+			<return type="void" />
+			<argument index="0" name="name" type="StringName" />
+			<argument index="1" name="value" type="String" />
+			<description>
+			</description>
+		</method>
+	</methods>
+	<members>
+		<member name="templates" type="Dictionary" setter="set_templates" getter="get_templates" default="{}">
+		</member>
+	</members>
+	<constants>
+	</constants>
+</class>