[PATCH] D61445: [FileCheck] Fix code style of method comments

[Paul Robinson via Phabricator via llvm-commits]

probinson accepted this revision.
probinson added a comment.
This revision is now accepted and ready to land.

Thanks!  Some small things, and LGTM once you've fixed those.



================
Comment at: llvm/include/llvm/Support/FileCheck.h:257
 
-  /// Return whether \p is a valid first character for a variable name.
+  /// \returns whether \p is a valid first character for a variable name.
   static bool isValidVarNameStart(char C);
----------------
I thought \p has to name the parameter? so "whether \p C is..."


================
Comment at: llvm/include/llvm/Support/FileCheck.h:271
                                            const SourceMgr &SM) const;
+  /// Parses the given string into the Pattern.
+  ///
----------------
What does "the Pattern" mean? There's no member or parameter named Pattern.


================
Comment at: llvm/include/llvm/Support/FileCheck.h:276
+  /// the input file from which the pattern string was read. \returns true in
+  /// case of an error, false otherwise.
   bool ParsePattern(StringRef PatternStr, StringRef Prefix, SourceMgr &SM,
----------------
Parameter Req is not mentioned.


================
Comment at: llvm/include/llvm/Support/FileCheck.h:403
   bool CheckSame(const SourceMgr &SM, StringRef Buffer) const;
+  /// Verifies that there is no "not strings" in the given \p Buffer.
   bool CheckNot(const SourceMgr &SM, StringRef Buffer,
----------------
there are no


================
Comment at: llvm/include/llvm/Support/FileCheck.h:434
+  /// The strings are added to the CheckStrings vector. \returns true in case
+  /// of an error, false otherwise.
   bool ReadCheckFile(SourceMgr &SM, StringRef Buffer, Regex &PrefixRE,
----------------
I could wish the parameters were described in detail, but that's beyond what you're doing in this patch.


================
Comment at: llvm/include/llvm/Support/FileCheck.h:446
+  /// Checks the input to FileCheck provided in the \p Buffer against the
+  /// \p CheckStrings read from the check file.
   ///
----------------
No doc for Diags (but again won't insist for this patch).


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D61445/new/

https://reviews.llvm.org/D61445