[Docu] Add information at Element.empty #2378

Closed
marcj opened this Issue Jul 2, 2012 · 1 comment

2 participants

@marcj

Developers should get a information that Element.empty fires only dispose (against my first guess of destroy) on all children. Maybe a advise like Call myElement.getChildren().destroy() to prepare all items for garbage collection should help, too.

I didn't know it before I have took a look into the code and have now some troubles resulting out this.

Also possible: since nobody should know it without looking in the code, I would recommend to call destroy instead of dispose like @kentaromiura it did in his pull request #2351 (4c68d39) to prevent a memory leak. But the hint mentioned above should also do it.

@DimitarChristoff
MooTools member

in all fairness, yes, http://mootools.net/docs/core/Element/Element#Element:empty is probably a bit vague. as a whole, it would be awesome if methods could be linked to a line on github where the source can be seen. in the meanwhile, if you feel that you can improve on the current documentation, here is the file: https://github.com/mootools/mootools-core/blob/master/Docs/Element/Element.md#element-method-empty-elementempty - fork, clone, make a branch quoting this issue, edit/update, test, push, send pull request.

@ibolmo ibolmo added a commit that closed this issue Mar 3, 2014
@ibolmo ibolmo Fixes #2378
Add note to Element.empty that GC is not used.
05a89f9
@ibolmo ibolmo closed this in 05a89f9 Mar 3, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment