Add Sphinx documentation.
This commit is contained in:
parent
c7afaf98db
commit
d0f0bae1c5
48 changed files with 12647 additions and 0 deletions
40
docs/source/doc/llvm.core.BasicBlock.md
Normal file
40
docs/source/doc/llvm.core.BasicBlock.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
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][]
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
[llvm.core.Value]: llvm.core.Value.html
|
||||
[llvm.core.Function]: llvm.core.Function.html
|
||||
Loading…
Add table
Add a link
Reference in a new issue