From 16514de50a7936950845a3851cae8ce571e0c2c2 Mon Sep 17 00:00:00 2001 From: Michael Ilseman Date: Wed, 19 Sep 2012 16:03:57 +0000 Subject: [PATCH] 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 --- include/llvm/Transforms/Utils/IntegerDivision.h | 8 ++++++++ 1 file changed, 8 insertions(+) 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 -- 2.34.1