[llvm-commits] [llvm] r164231 - /llvm/trunk/include/llvm/Transforms/Utils/IntegerDivision.h

[Michael Ilseman]

Author: milseman
Date: Wed Sep 19 11:03:57 2012
New Revision: 164231

URL: http://llvm.org/viewvc/llvm-project?rev=164231&view=rev
Log:
Document the interface for integer expansion, using doxygen-style comments

Modified:
    llvm/trunk/include/llvm/Transforms/Utils/IntegerDivision.h

Modified: llvm/trunk/include/llvm/Transforms/Utils/IntegerDivision.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Transforms/Utils/IntegerDivision.h?rev=164231&r1=164230&r2=164231&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Transforms/Utils/IntegerDivision.h (original)
+++ llvm/trunk/include/llvm/Transforms/Utils/IntegerDivision.h Wed Sep 19 11:03:57 2012
@@ -23,6 +23,14 @@
 
 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