[docs] Add LICENSE.txt to the root of the mono-repo
[llvm-project.git] / clang-tools-extra / docs / clang-tidy / checks / readability / uniqueptr-delete-release.rst
blobd5cee1587fb796f9367b56af30a9bdaba075d1ad
1 .. title:: clang-tidy - readability-uniqueptr-delete-release
3 readability-uniqueptr-delete-release
4 ====================================
6 Replace ``delete <unique_ptr>.release()`` with ``<unique_ptr> = nullptr``.
7 The latter is shorter, simpler and does not require use of raw pointer APIs.
9 .. code-block:: c++
11   std::unique_ptr<int> P;
12   delete P.release();
14   // becomes
16   std::unique_ptr<int> P;
17   P = nullptr;
19 Options
20 -------
22 .. option:: PreferResetCall
24   If `true`, refactor by calling the reset member function instead of
25   assigning to ``nullptr``. Default value is `false`.
27   .. code-block:: c++
29    std::unique_ptr<int> P;
30    delete P.release();
32    // becomes
34    std::unique_ptr<int> P;
35    P.reset();