Skip to content

Commit 1c17252

Browse files
authored
[NFC] Update comment in CommonOptionsParser to match documentation (#90441)
See https://clang.llvm.org/docs/LibTooling.html
1 parent 61b2a0e commit 1c17252

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

clang/include/clang/Tooling/CommonOptionsParser.h

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,22 @@ namespace tooling {
4949
/// using namespace clang::tooling;
5050
/// using namespace llvm;
5151
///
52-
/// static cl::OptionCategory MyToolCategory("My tool options");
52+
/// static cl::OptionCategory MyToolCategory("my-tool options");
5353
/// static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage);
5454
/// static cl::extrahelp MoreHelp("\nMore help text...\n");
55-
/// static cl::opt<bool> YourOwnOption(...);
56-
/// ...
5755
///
5856
/// int main(int argc, const char **argv) {
59-
/// CommonOptionsParser OptionsParser(argc, argv, MyToolCategory);
57+
/// auto ExpectedParser =
58+
/// CommonOptionsParser::create(argc, argv, MyToolCategory);
59+
/// if (!ExpectedParser) {
60+
/// llvm::errs() << ExpectedParser.takeError();
61+
/// return 1;
62+
/// }
63+
/// CommonOptionsParser& OptionsParser = ExpectedParser.get();
6064
/// ClangTool Tool(OptionsParser.getCompilations(),
6165
/// OptionsParser.getSourcePathList());
62-
/// return Tool.run(newFrontendActionFactory<SyntaxOnlyAction>().get());
66+
/// return Tool.run(
67+
/// newFrontendActionFactory<clang::SyntaxOnlyAction>().get());
6368
/// }
6469
/// \endcode
6570
class CommonOptionsParser {

0 commit comments

Comments
 (0)