[PATCH] D45981: [Docs] Escape the @ symbol, so that it appears in documentation output. [NFC]

Matt Davis via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Apr 26 08:49:23 PDT 2018


mattd added inline comments.


================
Comment at: include/llvm/Analysis/ScalarEvolution.h:1664
   /// Return true if the condition denoted by \p LHS \p Pred \p RHS is implied
-  /// by a call to \c @llvm.experimental.guard in \p BB.
+  /// by a call to \c \@llvm.experimental.guard in \p BB.
   bool isImpliedViaGuard(BasicBlock *BB, ICmpInst::Predicate Pred,
----------------
sanjoy wrote:
> Just checking -- is this necessary here?  Or will it show up as `\@llvm...` in generated documentation?
Thanks for the review!  I had a hunch that this might be a special case prior to submitting this patch.  This description only seems to show up in the ScalarEvolution_8h_source.html., and not in any of the fancy class description docs. I never see it listed in the ScalarEvolution class description doc.  I'm happy to leave this case untouched if you wish.  I did not see a similar case while grepping around.  


https://reviews.llvm.org/D45981





More information about the llvm-commits mailing list