diff options
Diffstat (limited to 'clang-tools-extra/clang-tidy/google/StringReferenceMemberCheck.h')
| -rw-r--r-- | clang-tools-extra/clang-tidy/google/StringReferenceMemberCheck.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/clang-tools-extra/clang-tidy/google/StringReferenceMemberCheck.h b/clang-tools-extra/clang-tidy/google/StringReferenceMemberCheck.h index 5ffea8a4e57..5a39fd9b372 100644 --- a/clang-tools-extra/clang-tidy/google/StringReferenceMemberCheck.h +++ b/clang-tools-extra/clang-tidy/google/StringReferenceMemberCheck.h @@ -17,25 +17,25 @@ namespace tidy { namespace google { namespace runtime { -/// \brief Finds members of type 'const string&'. +/// Finds members of type `const string&`. /// /// const string reference members are generally considered unsafe as they can /// be created from a temporary quite easily. /// /// \code -/// struct S { -/// S(const string &Str) : Str(Str) {} -/// const string &Str; -/// }; -/// S instance("string"); +/// struct S { +/// S(const string &Str) : Str(Str) {} +/// const string &Str; +/// }; +/// S instance("string"); /// \endcode /// -/// In the constructor call a string temporary is created from const char * and -/// destroyed immediately after the call. This leaves around a dangling +/// In the constructor call a string temporary is created from `const char *` +/// and destroyed immediately after the call. This leaves around a dangling /// reference. /// -/// This check emit warnings for both std::string and ::string const reference -/// members. +/// This check emit warnings for both `std::string` and `::string` const +/// reference members. /// /// Corresponding cpplint.py check name: 'runtime/member_string_reference'. class StringReferenceMemberCheck : public ClangTidyCheck { |

