From 5aafa3f54a7fd06798d8cdb9a77c1d8bce2a3789 Mon Sep 17 00:00:00 2001
From: "K. S. Ernest (iFire) Lee" <ernest.lee@chibifire.com>
Date: Sun, 20 Nov 2022 13:35:35 -0800
Subject: Add GLTFDocument documentation.

Co-authored-by: Meow <mosesturner@protonmail.com>
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
---
 modules/gltf/doc_classes/GLTFDocument.xml | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/modules/gltf/doc_classes/GLTFDocument.xml b/modules/gltf/doc_classes/GLTFDocument.xml
index 57727a7416..1967df5218 100644
--- a/modules/gltf/doc_classes/GLTFDocument.xml
+++ b/modules/gltf/doc_classes/GLTFDocument.xml
@@ -16,6 +16,8 @@
 			<param index="3" name="flags" type="int" default="0" />
 			<param index="4" name="bake_fps" type="int" default="30" />
 			<description>
+				Takes a [PackedByteArray] defining a gLTF and returns a [GLTFState] object through the [param state] parameter.
+				[b]Note:[/b] The [param base_path] tells [method append_from_buffer] where to find dependencies and can be empty.
 			</description>
 		</method>
 		<method name="append_from_file">
@@ -26,6 +28,8 @@
 			<param index="3" name="bake_fps" type="int" default="30" />
 			<param index="4" name="base_path" type="String" default="&quot;&quot;" />
 			<description>
+				Takes a path to a gLTF file and returns a [GLTFState] object through the [param state] parameter.
+				[b]Note:[/b] The [param base_path] tells [method append_from_file] where to find dependencies and can be empty.
 			</description>
 		</method>
 		<method name="append_from_scene">
@@ -35,12 +39,14 @@
 			<param index="2" name="flags" type="int" default="0" />
 			<param index="3" name="bake_fps" type="int" default="30" />
 			<description>
+				Takes a Godot Engine scene node and returns a [GLTFState] object through the [param state] parameter.
 			</description>
 		</method>
 		<method name="generate_buffer">
 			<return type="PackedByteArray" />
 			<param index="0" name="state" type="GLTFState" />
 			<description>
+				Takes a [GLTFState] object through the [param state] parameter and returns a gLTF [PackedByteArray].
 			</description>
 		</method>
 		<method name="generate_scene">
@@ -48,6 +54,7 @@
 			<param index="0" name="state" type="GLTFState" />
 			<param index="1" name="bake_fps" type="int" default="30" />
 			<description>
+				Takes a [GLTFState] object through the [param state] parameter and returns a Godot Engine scene node.
 			</description>
 		</method>
 		<method name="register_gltf_document_extension" qualifiers="static">
@@ -64,6 +71,8 @@
 			<param index="0" name="state" type="GLTFState" />
 			<param index="1" name="path" type="String" />
 			<description>
+				Takes a [GLTFState] object through the [param state] parameter and writes a glTF file to the filesystem.
+				[b]Note:[/b] The extension of the glTF file determines if it is a .glb binary file or a .gltf file.
 			</description>
 		</method>
 	</methods>
-- 
cgit v1.2.3