[Clang-tidy] Documentation style. Two Google checks are aliases

[alexfh]

docs/clang-tidy/checks/google-readability-namespace-comments.rst

9 ↗

(On Diff #69041)

Please move these links to the other document.

[Eugene.Zelenko]

Links are already there. Sorry for not uploading full diff at beginning.

[alexfh]

Awesome. Thanks! LG

clang-tools-extra/trunk/docs/clang-tidy/checks/google-readability-namespace-comments.rst

 .. title:: clang-tidy - google-readability-namespace-comments
+.. meta::
+   :http-equiv=refresh: 5;URL=llvm-namespace-comment.html
 
 google-readability-namespace-comments
 =====================================
 
-
-Checks that long namespaces have a closing comment.
-
-http://llvm.org/docs/CodingStandards.html#namespace-indentation
-
-https://google.github.io/styleguide/cppguide.html#Namespaces
+The google-readability-namespace-comments check is an alias, please see
+`llvm-namespace-comment <llvm-namespace-comment.html>`_ for more information.

clang-tools-extra/trunk/docs/clang-tidy/checks/google-readability-redundant-smartptr-get.rst

 .. title:: clang-tidy - google-readability-redundant-smartptr-get
+.. meta::
+   :http-equiv=refresh: 5;URL=readability-redundant-smartptr-get.html
 
 google-readability-redundant-smartptr-get
 =========================================
 
-
-Find and remove redundant calls to smart pointer's ``.get()`` method.
-
-Examples:
-
-.. code:: c++
-
-  ptr.get()->Foo()  ==>  ptr->Foo()
-  *ptr.get()  ==>  *ptr
-  *ptr->get()  ==>  **ptr
-
+The google-readability-redundant-smartptr-get check is an alias, please see
+`readability-redundant-smartptr-get <readability-redundant-smartptr-get.html>`_
+for more information.

clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst

.. toctree::
    google-build-namespaces
    google-build-using-namespace
    google-default-arguments
    google-explicit-constructor
    google-global-names-in-headers
    google-readability-braces-around-statements (redirects to readability-braces-around-statements) <google-readability-braces-around-statements>
    google-readability-casting
    google-readability-function-size (redirects to readability-function-size) <google-readability-function-size>
-   google-readability-namespace-comments
-   google-readability-redundant-smartptr-get
+   google-readability-namespace-comments (redirects to llvm-namespace-comment) <google-readability-namespace-comments>
+   google-readability-redundant-smartptr-get (redirects to readability-redundant-smartptr-get) <google-readability-redundant-smartptr-get>
    google-readability-todo
    google-runtime-int
    google-runtime-member-string-references
    google-runtime-memset
    google-runtime-operator
    google-runtime-references
    llvm-header-guard
    llvm-include-order

clang-tools-extra/trunk/docs/clang-tidy/checks/llvm-namespace-comment.rst

 .. title:: clang-tidy - llvm-namespace-comment
 
 llvm-namespace-comment
 ======================
 
+`google-readability-namespace-comments` redirects here as an alias for this
+check.
 
 Checks that long namespaces have a closing comment.
 
 http://llvm.org/docs/CodingStandards.html#namespace-indentation
 
 https://google.github.io/styleguide/cppguide.html#Namespaces

clang-tools-extra/trunk/docs/clang-tidy/checks/misc-definitions-in-headers.rst

 .. title:: clang-tidy - misc-definitions-in-headers
 
 misc-definitions-in-headers
 ===========================
 
 Finds non-extern non-inline function and variable definitions in header files,
 which can lead to potential ODR violations in case these headers are included
 from multiple translation units.
 
-.. code:: c++
+.. code-block:: c++
 
    // Foo.h
    int a = 1; // Warning: variable definition.
    extern int d; // OK: extern variable.
 
    namespace N {
      int e = 2; // Warning: variable definition.
    }
.. code-block:: c++
    }
 
    // OK: inline function definition is allowed to be defined multiple times.
    inline int e() {
      return 1;
    }
 
    class A {
-    public:
      int f1() { return 1; } // OK: implicitly inline member function definition is allowed.
      int f2();
+
      static int d;
    };
 
    // Warning: not an inline member function definition.
    int A::f2() { return 1; }
 
    // OK: class static data member declaration is allowed.
    int A::d = 1;

clang-tools-extra/trunk/docs/clang-tidy/checks/misc-string-constructor.rst

 .. title:: clang-tidy - misc-string-constructor
 
 misc-string-constructor
 =======================
 
 Finds string constructors that are suspicious and probably errors.
 
 A common mistake is to swap parameters to the 'fill' string-constructor.
 
 Examples:
 
-.. code:: c++
+.. code-block:: c++
 
   std::string('x', 50) str; // should be std::string(50, 'x') 
 
-
 Calling the string-literal constructor with a length bigger than the literal is
 suspicious and adds extra random characters to the string.
 
 Examples:
 
-.. code:: c++
+.. code-block:: c++
 
   std::string("test", 200);   // Will include random characters after "test".
 
-
 Creating an empty string from constructors with parameters is considered
 suspicious. The programmer should use the empty constructor instead.
 
 Examples:
 
-.. code:: c++
+.. code-block:: c++
 
   std::string("test", 0);   // Creation of an empty string.
-

clang-tools-extra/trunk/docs/clang-tidy/checks/readability-redundant-control-flow.rst

 .. title:: clang-tidy - readability-redundant-control-flow
 
 readability-redundant-control-flow
 ==================================
 
 This check looks for procedures (functions returning no value) with ``return``
-statements at the end of the function.  Such ``return`` statements are
-redundant.
+statements at the end of the function. Such ``return`` statements are redundant.
 
 Loop statements (``for``, ``while``, ``do while``) are checked for redundant
 ``continue`` statements at the end of the loop body.
 
 Examples:
 
-The following function `f` contains a redundant `return` statement:
+The following function `f` contains a redundant ``return`` statement:
 
-.. code:: c++
+.. code-block:: c++
 
   extern void g();
   void f() {
     g();
     return;
   }
 
 becomes
 
-.. code:: c++
+.. code-block:: c++
 
   extern void g();
   void f() {
     g();
   }
 
-The following function `k` contains a redundant `continue` statement:
+The following function `k` contains a redundant ``continue`` statement:
 
-.. code:: c++
+.. code-block:: c++
 
   void k() {
     for (int i = 0; i < 10; ++i) {
       continue;
     }
   }
 
 becomes
 
-.. code:: c++
+.. code-block:: c++
 
   void k() {
     for (int i = 0; i < 10; ++i) {
     }
   }

clang-tools-extra/trunk/docs/clang-tidy/checks/readability-redundant-smartptr-get.rst

 .. title:: clang-tidy - readability-redundant-smartptr-get
 
 readability-redundant-smartptr-get
 ==================================
 
+`google-readability-redundant-smartptr-get` redirects here as an alias for this
+check.
 
 Find and remove redundant calls to smart pointer's ``.get()`` method.
 
 Examples:
 
-.. code:: c++
+.. code-block:: c++
 
   ptr.get()->Foo()  ==>  ptr->Foo()
   *ptr.get()  ==>  *ptr
   *ptr->get()  ==>  **ptr