[PATCH] D36530: [Parse] Document PrintStats, SkipFunctionBodies

[Brian Gesiak via Phabricator via cfe-commits]

modocache created this revision.

Add documentation for `clang::ParseAST` parameters `PrintStats` and
`SkipFunctionBodies`. Also, remove a tiny bit of trailing whitespace.


https://reviews.llvm.org/D36530

Files:
  include/clang/Parse/ParseAST.h


Index: include/clang/Parse/ParseAST.h
===================================================================
--- include/clang/Parse/ParseAST.h
+++ include/clang/Parse/ParseAST.h
@@ -29,10 +29,13 @@
   /// This operation inserts the parsed decls into the translation
   /// unit held by Ctx.
   ///
+  /// \param PrintStats Whether to print LLVM statistics related to parsing.
   /// \param TUKind The kind of translation unit being parsed.
-  ///
   /// \param CompletionConsumer If given, an object to consume code completion
   /// results.
+  /// \param SkipFunctionBodies Whether to skip parsing of function bodies.
+  /// This option can be used, for example, to speed up searches for
+  /// delcarations/definitions when indexing.
   void ParseAST(Preprocessor &pp, ASTConsumer *C,
                 ASTContext &Ctx, bool PrintStats = false,
                 TranslationUnitKind TUKind = TU_Complete,
@@ -43,7 +46,7 @@
   /// abstract syntax tree.
   void ParseAST(Sema &S, bool PrintStats = false,
                 bool SkipFunctionBodies = false);
-  
+
 }  // end namespace clang
 
 #endif


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D36530.110423.patch
Type: text/x-patch
Size: 1096 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20170809/8c9245be/attachment-0001.bin>