summaryrefslogtreecommitdiff
path: root/include/llvm/IR/IRBuilder.h
diff options
context:
space:
mode:
authorMichael Gottesman <mgottesman@apple.com>2013-01-30 22:56:31 +0000
committerMichael Gottesman <mgottesman@apple.com>2013-01-30 22:56:31 +0000
commitbc977bab42fb3f45df054af63b4bd748300f005a (patch)
treeccdf76c0773a07e75424b2f6aa304348472594b2 /include/llvm/IR/IRBuilder.h
parentf84d4c16b3d5b0c687dd6f25c340b3b86c76fc34 (diff)
downloadllvm-bc977bab42fb3f45df054af63b4bd748300f005a.tar.gz
llvm-bc977bab42fb3f45df054af63b4bd748300f005a.tar.bz2
llvm-bc977bab42fb3f45df054af63b4bd748300f005a.tar.xz
Doxygenified some comments in IRBuilder.h.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@173986 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/IR/IRBuilder.h')
-rw-r--r--include/llvm/IR/IRBuilder.h17
1 files changed, 9 insertions, 8 deletions
diff --git a/include/llvm/IR/IRBuilder.h b/include/llvm/IR/IRBuilder.h
index 567f5cbf7f..1c71d0a901 100644
--- a/include/llvm/IR/IRBuilder.h
+++ b/include/llvm/IR/IRBuilder.h
@@ -28,10 +28,11 @@
namespace llvm {
class MDNode;
-/// IRBuilderDefaultInserter - This provides the default implementation of the
-/// IRBuilder 'InsertHelper' method that is called whenever an instruction is
-/// created by IRBuilder and needs to be inserted. By default, this inserts the
-/// instruction at the insertion point.
+/// \brief This provides the default implementation of the IRBuilder
+/// 'InsertHelper' method that is called whenever an instruction is created by
+/// IRBuilder and needs to be inserted.
+///
+/// By default, this inserts the instruction at the insertion point.
template <bool preserveNames = true>
class IRBuilderDefaultInserter {
protected:
@@ -43,7 +44,7 @@ protected:
}
};
-/// IRBuilderBase - Common base class shared among various IRBuilders.
+/// \brief Common base class shared among various IRBuilders.
class IRBuilderBase {
DebugLoc CurDbgLocation;
protected:
@@ -330,9 +331,9 @@ private:
Value *getCastedInt8PtrValue(Value *Ptr);
};
-/// IRBuilder - This provides a uniform API for creating instructions and
-/// inserting them into a basic block: either at the end of a BasicBlock, or
-/// at a specific iterator location in a block.
+/// \brief This provides a uniform API for creating instructions and inserting
+/// them into a basic block: either at the end of a BasicBlock, or at a specific
+/// iterator location in a block.
///
/// Note that the builder does not expose the full generality of LLVM
/// instructions. For access to extra instruction properties, use the mutators