Skip to content

Commit

Permalink
Update clang-tidy documentation.
Browse files Browse the repository at this point in the history
Summary:
Improve modernize-use-auto documentation (https://llvm.org/bugs/show_bug.cgi?id=24962).
Add documentation for modernize-make-unique.

Reviewers: klimek

Subscribers: cfe-commits, alexfh

Differential Revision: http://reviews.llvm.org/D13346

llvm-svn: 249017
  • Loading branch information
angargo committed Oct 1, 2015
1 parent 44f5d91 commit 05ca3ec
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
1 change: 1 addition & 0 deletions clang-tools-extra/docs/clang-tidy/checks/list.rst
Expand Up @@ -42,6 +42,7 @@ List of clang-tidy Checks
misc-unused-parameters
misc-unused-raii
modernize-loop-convert
modernize-make-unique
modernize-pass-by-value
modernize-replace-auto-ptr
modernize-shrink-to-fit
Expand Down
15 changes: 15 additions & 0 deletions clang-tools-extra/docs/clang-tidy/checks/modernize-make-unique.rst
@@ -0,0 +1,15 @@
modernize-make-unique
=====================

This check finds the creation of ``std::unique_ptr`` objects by explicitly
calling the constructor and a ``new`` expression, and replaces it with a call
to ``std::make_unique``, introduced in C++14.

.. code-block:: c++

auto my_ptr = std::unique_ptr<MyPair>(new MyPair(1, 2));

// becomes

auto my_ptr = std::make_unique<MyPair>(1, 2);

33 changes: 33 additions & 0 deletions clang-tools-extra/docs/clang-tidy/checks/modernize-use-auto.rst
Expand Up @@ -108,6 +108,39 @@ conditions are satisfied:
list. Otherwise, use of ``auto`` would cause the type of the variable to be
deduced as``std::initializer_list``.

New expressions
---------------

Frequently, when a pointer is declared and initialized with ``new``, the
pointee type has to be written twice: in the declaration type and in the
``new`` expression. In this cases, the declaration type can be replaced with
``auto`` improving readability and maintainability.

.. code-block:: c++

TypeName *my_pointer = new TypeName(my_param);
// becomes

auto my_pointer = new TypeName(my_param);

The check will also replace the declaration type in multiple declarations, if
the following conditions are satisfied:

* All declared variables have the same type (i.e. all of them are pointers to
the same type).
* All declared variables are initialized with a ``new`` expression.
* The types of all the new expressions are the same than the pointee of the
declaration type.

.. code-block:: c++

TypeName *my_first_pointer = new TypeName, *my_second_pointer = new TypeName;
// becomes

auto my_first_pointer = new TypeName, my_second_pointer = new TypeName;

Known Limitations
-----------------
* If the initializer is an explicit conversion constructor, the check will not
Expand Down

0 comments on commit 05ca3ec

Please sign in to comment.