Document the interface for integer expansion, using doxygen-style comments

llvm-svn: 164231

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