diff options
author | milseman <milseman@91177308-0d34-0410-b5e6-96231b3b80d8> | 2012-09-19 16:03:57 +0000 |
---|---|---|
committer | milseman <milseman@91177308-0d34-0410-b5e6-96231b3b80d8> | 2012-09-19 16:03:57 +0000 |
commit | e104016e74a26648746c29ec96493fe98c00195c (patch) | |
tree | 8abc652e9d2ac9aae069a82f49228f21ad1ad583 /include | |
parent | da68a190099b28dd9377223ced62793719e83a6e (diff) |
Document the interface for integer expansion, using doxygen-style comments
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164231 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
-rw-r--r-- | include/llvm/Transforms/Utils/IntegerDivision.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/include/llvm/Transforms/Utils/IntegerDivision.h b/include/llvm/Transforms/Utils/IntegerDivision.h index a8008ee066d..8d3f53e6f90 100644 --- a/include/llvm/Transforms/Utils/IntegerDivision.h +++ b/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 |