Some classes have docstrings, and lack rST docs (e.g. Module), few others vice versa. It's unclear what is the best way to deal with this. IMHO, docstrings should prevail, i.e. existing docs would rather be moved to docstings. Anyway, for now just make sure that users don't miss documentation, even if it's just list of classmembers.
51 lines
1 KiB
ReStructuredText
51 lines
1 KiB
ReStructuredText
+---------------------------------+
|
|
| layout: page |
|
|
+---------------------------------+
|
|
| title: BasicBlock (llvm.core) |
|
|
+---------------------------------+
|
|
|
|
A basicblock is a list of instructions. A wellformed basicblock should
|
|
end with a terminator. ``Function.verify()`` will verify that. A
|
|
terminator is either a branch instruction or return instruction. It is
|
|
not possible to have instructions after a branch or return instruction.
|
|
|
|
llvm.core.BasicBlock
|
|
====================
|
|
|
|
Base Class
|
|
----------
|
|
|
|
- `llvm.core.Value <llvm.core.Value.html>`_
|
|
|
|
Methods
|
|
-------
|
|
|
|
``delete(self)``
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
Delete this basicblock from the function (``self.function``).
|
|
|
|
``insert_before(self, name)``
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
TODO
|
|
|
|
Proporties
|
|
----------
|
|
|
|
``function``
|
|
~~~~~~~~~~~~
|
|
|
|
The parent function of this basicblock.
|
|
|
|
``instructions``
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
A list of instructions in this basicblock.
|
|
|
|
|
|
Automatically Generated Documentation
|
|
-------------------------------------
|
|
.. autoclass:: llvm.core.BasicBlock
|
|
:members:
|
|
:undoc-members:
|