Reword the documentation for the `mlirTranslateMain` API (NFC)
authorMehdi Amini <joker.eph@gmail.com>
Sun, 23 Aug 2020 04:35:58 +0000 (04:35 +0000)
committerMehdi Amini <joker.eph@gmail.com>
Sun, 23 Aug 2020 04:35:58 +0000 (04:35 +0000)
Address post-commit review in https://reviews.llvm.org/D86408

mlir/include/mlir/Translation.h

index ab9dad8..79220cc 100644 (file)
@@ -95,8 +95,11 @@ struct TranslationParser : public llvm::cl::parser<const TranslateFunction *> {
                        size_t globalWidth) const override;
 };
 
-/// Implementation for tools like `mlir-translate`. ToolName is used for the
-/// header displayed by `--help`.
+/// Translate to/from an MLIR module from/to an external representation (e.g.
+/// LLVM IR, SPIRV binary, ...). This is the entry point for the implementation
+/// of tools like `mlir-translate`. The translation to perform is parsed from
+/// the command line. The `toolName` argument is used for the header displayed
+/// by `--help`.
 LogicalResult mlirTranslateMain(int argc, char **argv,
                                 llvm::StringRef toolName);