llvmorg-github-actions[bot] wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-clang Author: Jinpeng Wang (jjppp) <details> <summary>Changes</summary> Replace the stale "Introduce link to ASTMatchersTutorial.html" FIXMEs with a link to the existing LibASTMatchersTutorial, drop the ASTMatchersCookbook FIXMEs (no cookbook exists), and fix the "macros (see below)" reference which should point to the AST_MATCHER_P section above. --- Full diff: https://github.com/llvm/llvm-project/pull/219741.diff 1 Files Affected: - (modified) clang/docs/LibASTMatchers.md (+3-12) ``````````diff diff --git a/clang/docs/LibASTMatchers.md b/clang/docs/LibASTMatchers.md index f5c4109c30406..24c66c5f7c898 100644 --- a/clang/docs/LibASTMatchers.md +++ b/clang/docs/LibASTMatchers.md @@ -9,8 +9,6 @@ We assume basic knowledge about the Clang AST. See the {doc}`Introduction to the Clang AST <IntroductionToTheClangAST>` if you want to learn more about how the AST is structured. -% FIXME: create tutorial and link to the tutorial - ## Introduction LibASTMatchers provides a domain specific language to create predicates on @@ -47,9 +45,8 @@ want to match looks like. The {doc}`Introduction to the Clang AST <IntroductionToTheClangAST>` teaches you how to dump a translation unit's AST into a human readable format. -% FIXME: Introduce link to ASTMatchersTutorial.html - -% FIXME: Introduce link to ASTMatchersCookbook.html +If you are looking for a step-by-step walkthrough of writing a tool based on +LibASTMatchers, see the {doc}`LibASTMatchersTutorial`. In general, the strategy to create the right matchers is: @@ -74,10 +71,6 @@ are bindable; for example, `recordDecl(hasName("MyClass")).bind("id")` will bind the matched `recordDecl` node to the string "`id`", to be later retrieved in the [match callback](https://clang.llvm.org/doxygen/classclang_1_1ast__matchers_1_1MatchFinder_1_1MatchCallback.html). -% FIXME: Introduce link to ASTMatchersTutorial.html - -% FIXME: Introduce link to ASTMatchersCookbook.html - ## Writing your own matchers There are multiple different ways to define a matcher, depending on its type @@ -112,8 +105,6 @@ values and different parameter counts. See [ASTMatchersMacros.h](https://clang.l Matchers are generated by nesting calls to matcher creation functions. Most of the time those functions are either created by using -`VariadicDynCastAllOfMatcher` or the matcher creation macros (see below). +`VariadicDynCastAllOfMatcher` or the matcher creation macros (see above). The free-standing functions are an indication that this matcher is just a combination of other matchers, as is for example the case with [callee](LibASTMatchersReference.html#callee1Anchor). - -% FIXME: "... macros (see below)" --- there isn't anything below `````````` </details> https://github.com/llvm/llvm-project/pull/219741 _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
