summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Ilseman <milseman@apple.com>2012-09-19 16:03:57 +0000
committerMichael Ilseman <milseman@apple.com>2012-09-19 16:03:57 +0000
commitc4149a10b4b6aea8adb94f4733f9f8dbb1a69238 (patch)
tree6b3dad3bb53a0463517e2c8af7949ca14cb024e7
parent623c5cda082367baf242b5c661c3a8ac71fc63b5 (diff)
downloadbcm5719-llvm-c4149a10b4b6aea8adb94f4733f9f8dbb1a69238.tar.gz
bcm5719-llvm-c4149a10b4b6aea8adb94f4733f9f8dbb1a69238.zip
Document the interface for integer expansion, using doxygen-style comments
llvm-svn: 164231
-rw-r--r--llvm/include/llvm/Transforms/Utils/IntegerDivision.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/llvm/include/llvm/Transforms/Utils/IntegerDivision.h b/llvm/include/llvm/Transforms/Utils/IntegerDivision.h
index a8008ee066d..8d3f53e6f90 100644
--- a/llvm/include/llvm/Transforms/Utils/IntegerDivision.h
+++ b/llvm/include/llvm/Transforms/Utils/IntegerDivision.h
@@ -23,6 +23,14 @@ namespace llvm {
namespace llvm {
+ /// Generate code to divide two integers, replacing Div with the generated
+ /// code. This currently generates code similarly to compiler-rt's
+ /// implementations, but future work includes generating more specialized code
+ /// when more information about the operands are known. Currently only
+ /// implements 32bit scalar division, but future work is removing this
+ /// limitation.
+ ///
+ /// @brief Replace Div with generated code.
bool expandDivision(BinaryOperator* Div);
} // End llvm namespace
OpenPOWER on IntegriCloud