maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[clang-tidy] Updated misc-unused-raii documentation. 

llvm-svn: 248594
This commit is contained in:
Alexander Kornienko 2015-09-25 17:50:11 +00:00
parent 1bbd7fb38e
commit 91b53846f7
2 changed files with 6 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
clang-tools-extra/clang-tidy/misc/UnusedRAIICheck.h
View File

@ -18,28 +18,8 @@ namespace misc {
/// Finds temporaries that look like RAII objects.
///
/// The canonical example for this is a scoped lock.
///
/// \code
/// {
/// scoped_lock(&global_mutex);
/// critical_section();
/// }
/// \endcode
///
/// The destructor of the scoped_lock is called before the `critical_section` is
/// entered, leaving it unprotected.
///
/// We apply a number of heuristics to reduce the false positive count of this
/// check:
///
/// * Ignore code expanded from macros. Testing frameworks make heavy use of
/// this.
/// * Ignore types with no user-declared constructor. Those are very unlikely
/// to be RAII objects.
/// * Ignore objects at the end of a compound statement (doesn't change
/// behavior).
/// * Ignore objects returned from a call.
/// For the user-facing documentation see:
/// http://clang.llvm.org/extra/clang-tidy/checks/misc-unused-raii.html
class UnusedRAIICheck : public ClangTidyCheck {
public:
UnusedRAIICheck(StringRef Name, ClangTidyContext *Context)

10
clang-tools-extra/docs/clang-tidy/checks/misc-unused-raii.rst
View File

@ -19,10 +19,8 @@ entered, leaving it unprotected.
We apply a number of heuristics to reduce the false positive count of this
check:
* Ignore code expanded from macros. Testing frameworks make heavy use of
this.
* Ignore types with no user-declared constructor. Those are very unlikely
to be RAII objects.
* Ignore objects at the end of a compound statement (doesn't change
behavior).
* Ignore code expanded from macros. Testing frameworks make heavy use of this.
* Ignore types with trivial destructors. They are very unlikely to be RAII
objects and there's no difference when they are deleted.
* Ignore objects at the end of a compound statement (doesn't change behavior).
* Ignore objects returned from a call.