Skip to content

Commit 11c0832

Browse files
authored
[MLIR][LLVM] Improve module translation comment (NFC) (#94577)
This commit enhances the docsting of `translateModuleToLLVMIR` as a followup to #94445
1 parent 46edc02 commit 11c0832

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

mlir/include/mlir/Target/LLVMIR/Export.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ class Module;
2020
namespace mlir {
2121
class Operation;
2222

23-
/// Translate operation that satisfies LLVM dialect module requirements into an
24-
/// LLVM IR module living in the given context. This translates operations from
25-
/// any dilalect that has a registered implementation of
26-
/// LLVMTranslationDialectInterface.
23+
/// Translates a given LLVM dialect `module` into an LLVM IR module living in
24+
/// the given context. Operates on any operation from dialects that provide a
25+
/// registered implementation of the LLVMTranslationDialectInterface. Returns
26+
/// nullptr when the translation fails.
27+
/// Verifies the produced LLVM module, except when `disableVerification` is set.
2728
std::unique_ptr<llvm::Module>
2829
translateModuleToLLVMIR(Operation *module, llvm::LLVMContext &llvmContext,
2930
llvm::StringRef name = "LLVMDialectModule",

0 commit comments

Comments
 (0)