fix comment

Author: HerrCai0907

clang-tools-extra/clang-tidy/bugprone/ReturnConstRefFromParameterCheck.cpp

@@ -27,8 +27,8 @@ void ReturnConstRefFromParameterCheck::check(
     const MatchFinder::MatchResult &Result) {
   const auto *R = Result.Nodes.getNodeAs<ReturnStmt>("ret");
   diag(R->getRetValue()->getBeginLoc(),
-       "return const reference parameter cause potential use-after-free "
-       "when function accepts immediately constructed value.");
+       "returning a constant reference parameter may cause a use-after-free "
+       "when the parameter is constructed from a temporary");
 }
 
 } // namespace clang::tidy::bugprone

clang-tools-extra/clang-tidy/bugprone/ReturnConstRefFromParameterCheck.h

@@ -13,9 +13,9 @@
 
 namespace clang::tidy::bugprone {
 
-/// Detects the function which returns the const reference parameter as const
-/// reference. This might causes potential use after free errors if the caller
-/// uses xvalue as arguments.
+/// Detects return statements that return constant reference parameter as
+/// constant reference. This may cause use-after-free errors if the caller uses
+/// xvalue as arguments.
 ///
 /// For the user-facing documentation see:
 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/return-const-ref-from-parameter.html

clang-tools-extra/docs/ReleaseNotes.rst

@@ -115,8 +115,9 @@ New checks
 - New :doc:`bugprone-return-const-ref-from-parameter
   <clang-tidy/checks/bugprone/return-const-ref-from-parameter>` check.
 
-  Detects the function which returns the const reference from parameter which
-  causes potential use after free if the caller uses xvalue as argument.
+  Detects return statements that return constant reference parameter as constant
+  reference. This may cause use-after-free errors if the caller uses xvalue as
+  arguments.
 
 - New :doc:`bugprone-suspicious-stringview-data-usage
   <clang-tidy/checks/bugprone/suspicious-stringview-data-usage>` check.

clang-tools-extra/docs/clang-tidy/checks/bugprone/return-const-ref-from-parameter.rst

@@ -3,12 +3,12 @@
 bugprone-return-const-ref-from-parameter
 ========================================
 
-Detects the function which returns the const reference parameter as const
-reference. This might causes potential use after free errors if the caller
-uses xvalue as arguments.
+Detects return statements that return constant reference parameter as constant
+reference. This may cause use-after-free errors if the caller uses xvalue as
+arguments.
 
-In C++, const reference parameters can accept xvalues which will be destructed
-after the call. When the function returns such a parameter also as const reference,
+In C++, constant reference parameters can accept xvalues which will be destructed
+after the call. When the function returns such a parameter also as constant reference,
 then the returned reference can be used after the object it refers to has been
 destroyed.
 

clang-tools-extra/test/clang-tidy/checkers/bugprone/return-const-ref-from-parameter.cpp

@@ -7,16 +7,16 @@ using TConstRef = int const&;
 namespace invalid {
 
 int const &f1(int const &a) { return a; }
-// CHECK-MESSAGES: :[[@LINE-1]]:38: warning: return const reference parameter
+// CHECK-MESSAGES: :[[@LINE-1]]:38: warning: returning a constant reference parameter
 
 int const &f2(T const &a) { return a; }
-// CHECK-MESSAGES: :[[@LINE-1]]:36: warning: return const reference parameter
+// CHECK-MESSAGES: :[[@LINE-1]]:36: warning: returning a constant reference parameter
 
 int const &f3(TConstRef a) { return a; }
-// CHECK-MESSAGES: :[[@LINE-1]]:37: warning: return const reference parameter
+// CHECK-MESSAGES: :[[@LINE-1]]:37: warning: returning a constant reference parameter
 
 int const &f4(TConst &a) { return a; }
-// CHECK-MESSAGES: :[[@LINE-1]]:35: warning: return const reference parameter
+// CHECK-MESSAGES: :[[@LINE-1]]:35: warning: returning a constant reference parameter
 
 } // namespace invalid