diff options
| author | reduz <reduzio@gmail.com> | 2021-08-24 15:16:25 -0300 |
|---|---|---|
| committer | reduz <reduzio@gmail.com> | 2021-08-24 15:28:29 -0300 |
| commit | 96f8254b24109884bdc3f6a7e224a8045b27ee15 (patch) | |
| tree | fb69f60c58bdd5d1b34ad9362eb0460ebc519c31 /doc/classes | |
| parent | ca7f53dd25cd7ee52004a09d4b7ababb9fa0bca6 (diff) | |
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.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/ConfigFile.xml | 2 |
1 files changed, 2 insertions, 0 deletions
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. |