micropython/docs/library/gc.rst
Damien George 88d3054ac0 docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00

31 lines
514 B
ReStructuredText

:mod:`gc` --- control the garbage collector
===========================================
.. module:: gc
:synopsis: control the garbage collector
Functions
---------
.. function:: collect()
Run a garbage collection.
.. function:: disable()
Disable the garbage collector.
.. function:: enable()
Enable the garbage collector.
.. function:: mem_alloc()
Return the number of bytes of heap RAM that are allocated.
.. function:: mem_free()
Return the number of bytes of available heap RAM.