diff options
Diffstat (limited to 'src/checks/level2/README-function-args-by-ref.md')
| -rw-r--r-- | src/checks/level2/README-function-args-by-ref.md | 11 |
1 files changed, 0 insertions, 11 deletions
diff --git a/src/checks/level2/README-function-args-by-ref.md b/src/checks/level2/README-function-args-by-ref.md deleted file mode 100644 index d755bfbc..00000000 --- a/src/checks/level2/README-function-args-by-ref.md +++ /dev/null @@ -1,11 +0,0 @@ -# function-args-by-ref - -Warns when you should be passing by const-ref. -Types with sizeof > 16 bytes [1] or types which are not trivially-copyable [2] or not trivially-destructible [3] should be passed by ref. A rule of thumb is that if passing by value would trigger copy-ctor and/or dtor then pass by ref instead. - -This check will ignore shared pointers, you're on your own. Most of the times passing shared pointers by const-ref is the best thing to do, but occasionally that will lead to crashes if you're in a method that calls something else that makes the shared pointer ref count go down to zero. - - -- [1] <http://www.macieira.org/blog/2012/02/the-value-of-passing-by-value/> -- [2] <http://en.cppreference.com/w/cpp/concept/TriviallyCopyable> -- [3] <http://www.cplusplus.com/reference/type_traits/is_trivially_destructible/> |