summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJummit <jummit@web.de>2021-01-03 09:26:07 +0100
committerJummit <jummit@web.de>2021-09-12 09:18:52 +0200
commita6108f8a3dea4d05a197b5c01b0195ff8f56be35 (patch)
tree2a8e885ca21af01c48291aa7d83f41377ce05344
parent828d1ea59eb95edc840ca25de5f8c594fd9b584e (diff)
clarify what duplicate does and its limitations
-rw-r--r--doc/classes/Resource.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml
index 1ce2c376dd..34a9ade486 100644
--- a/doc/classes/Resource.xml
+++ b/doc/classes/Resource.xml
@@ -25,7 +25,8 @@
<argument index="0" name="subresources" type="bool" default="false">
</argument>
<description>
- Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
+ Duplicates the resource, returning a new resource with the exported members copied. [b]Note:[/b] To duplicate the resource the constructor is called without arguments. This method will error when the constructor doesn't have default values.
+ By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
[b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
</description>
</method>