summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
diff options
context:
space:
mode:
authorAlexander Kornienko <alexfh@google.com>2015-08-27 18:10:07 +0000
committerAlexander Kornienko <alexfh@google.com>2015-08-27 18:10:07 +0000
commitaabfadef84cdcc6aef529348a287e0130f7aee6d (patch)
treec1f69930d251e6b4af7d9d2cc9a17967eb63ff9f /clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
parent5ce1a84f9a0ae21848b2b7842ae90c2a37d6f6e3 (diff)
downloadbcm5719-llvm-aabfadef84cdcc6aef529348a287e0130f7aee6d.tar.gz
bcm5719-llvm-aabfadef84cdcc6aef529348a287e0130f7aee6d.zip
[clang-tidy] Move clang-tidy docs to a separate directory. Create doc files for checks
The doc files for checks have been generated from the corresponding header files using the docs/clang-tidy/tools/dump_check_docs.py script. Committing the script as well, but the intention is to move all the user-facing docs from header files to the rST files and add links to .h files appropriately. llvm-svn: 246173
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
new file mode 100644
index 00000000000..9d6438fbca8
--- /dev/null
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
@@ -0,0 +1,11 @@
+misc-noexcept-move-constructor
+==============================
+
+
+The check flags user-defined move constructors and assignment operators not
+marked with ``noexcept`` or marked with ``noexcept(expr)`` where ``expr``
+evaluates to ``false`` (but is not a ``false`` literal itself).
+
+Move constructors of all the types used with STL containers, for example,
+need to be declared ``noexcept``. Otherwise STL will choose copy constructors
+instead. The same is valid for move assignment operations.
OpenPOWER on IntegriCloud