summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h')
-rw-r--r--clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h b/clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h
index e5d05c968f2..1da61958595 100644
--- a/clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h
+++ b/clang-tools-extra/clang-tidy/readability/RedundantSmartptrGetCheck.h
@@ -16,12 +16,15 @@ namespace clang {
namespace tidy {
namespace readability {
-/// \brief Find and remove redundant calls to smart pointer's .get() method.
+/// Find and remove redundant calls to smart pointer's `.get()` method.
///
/// Examples:
+///
+/// \code
/// ptr.get()->Foo() ==> ptr->Foo()
/// *ptr.get() ==> *ptr
/// *ptr->get() ==> **ptr
+/// \endcode
class RedundantSmartptrGetCheck : public ClangTidyCheck {
public:
RedundantSmartptrGetCheck(StringRef Name, ClangTidyContext *Context)
OpenPOWER on IntegriCloud