From 96f8254b24109884bdc3f6a7e224a8045b27ee15 Mon Sep 17 00:00:00 2001
From: reduz <reduzio@gmail.com>
Date: Tue, 24 Aug 2021 15:16:25 -0300
Subject: Implement error return documetation

Adds ability to add error return documetation to the binder and class reference.
Usage example:

```C++
void MyClass::_bind_method() {
	[..]
	BIND_METHOD_ERR_RETURN_DOC("load", ERR_FILE_CANT_OPEN, ERR_FILE_UNRECOGNIZED);
}
```

One function of ConfigFile was changed as example.
---
 doc/classes/ConfigFile.xml | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'doc/classes')

diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml
index f970be23a6..d6da4bc248 100644
--- a/doc/classes/ConfigFile.xml
+++ b/doc/classes/ConfigFile.xml
@@ -149,6 +149,8 @@
 		</method>
 		<method name="load">
 			<return type="int" enum="Error" />
+			<returns_error number="0"/>
+			<returns_error number="12"/>
 			<argument index="0" name="path" type="String" />
 			<description>
 				Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
-- 
cgit v1.2.3