[clang-tidy] Update documentation for

'bugprone-inconsistent-ifelse-braces'

Author: capitan-davide

clang-tools-extra/clang-tidy/bugprone/InconsistentIfelseBracesCheck.cpp

@@ -1,4 +1,3 @@
-
 //===----------------------------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
@@ -47,10 +46,6 @@ void InconsistentIfelseBracesCheck::check(
   const auto *MatchedIf = Result.Nodes.getNodeAs<IfStmt>("if_stmt");
   if (!shouldHaveBraces(MatchedIf))
     return;
-
-  // TODO: Test behavior with macros. This might be the reason why
-  // readability-braces-around-statements defines a findRParenLoc() function
-  // rather than using IfStmt/WhileStmt::getRParenLoc().
   checkIfStmt(Result, MatchedIf);
 }
 
@@ -62,17 +57,15 @@ void InconsistentIfelseBracesCheck::checkIfStmt(
     // it, then we need to check the inner IfStmt.
     checkStmt(Result, If->getThen(), If->getRParenLoc(), If->getElseLoc());
     if (shouldHaveBraces(NestedIf))
-      return checkIfStmt(Result, NestedIf);
-  }
-
-  if (!isa<CompoundStmt>(Then))
+      checkIfStmt(Result, NestedIf);
+  } else if (!isa<CompoundStmt>(Then)) {
     checkStmt(Result, If->getThen(), If->getRParenLoc(), If->getElseLoc());
+  }
 
   if (const Stmt *const Else = If->getElse()) {
     if (const auto *NestedIf = dyn_cast<const IfStmt>(Else))
-      return checkIfStmt(Result, NestedIf);
-
-    if (!isa<CompoundStmt>(Else))
+      checkIfStmt(Result, NestedIf);
+    else if (!isa<CompoundStmt>(Else))
       checkStmt(Result, If->getElse(), If->getElseLoc());
   }
 }
@@ -92,4 +85,5 @@ void InconsistentIfelseBracesCheck::checkStmt(
     }
   }
 }
+
 } // namespace clang::tidy::bugprone

clang-tools-extra/clang-tidy/bugprone/InconsistentIfelseBracesCheck.h

@@ -1,4 +1,3 @@
-
 //===----------------------------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
@@ -14,7 +13,8 @@
 
 namespace clang::tidy::bugprone {
 
-/// FIXME: Write a short description.
+/// Detects `if`/`else` statements where one branch uses braces and the other
+/// does not.
 ///
 /// For the user-facing documentation see:
 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/inconsistent-ifelse-braces.html

clang-tools-extra/docs/ReleaseNotes.rst

@@ -160,7 +160,8 @@ New checks
 - New :doc:`bugprone-inconsistent-ifelse-braces
   <clang-tidy/checks/bugprone/inconsistent-ifelse-braces>` check.
 
-  FIXME: Write a short description.
+  Detects ``if``/``else`` statements where one branch uses braces and the other
+  does not.
 
 - New :doc:`bugprone-invalid-enum-default-initialization
   <clang-tidy/checks/bugprone/invalid-enum-default-initialization>` check.

clang-tools-extra/docs/clang-tidy/checks/bugprone/inconsistent-ifelse-braces.rst

@@ -3,4 +3,40 @@
 bugprone-inconsistent-ifelse-braces
 ===================================
 
-FIXME: Describe what patterns does the check detect and why. Give examples.
+Detects ``if``/``else`` statements where one branch uses braces and the other
+does not.
+
+Before:
+
+.. code-block:: c++
+
+  if (condition) {
+    statement;
+  } else
+    statement;
+
+  if (condition)
+    statement;
+  
+  if (condition)
+    statement;
+  else
+    statement;
+
+After:
+
+.. code-block:: c++
+
+  if (condition) {
+    statement;
+  } else {
+    statement;
+  }
+
+  if (condition)
+    statement;
+  
+  if (condition)
+    statement;
+  else
+    statement;

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

@@ -101,7 +101,7 @@ Clang-Tidy Checks
    :doc:`bugprone-implicit-widening-of-multiplication-result <bugprone/implicit-widening-of-multiplication-result>`, "Yes"
    :doc:`bugprone-inaccurate-erase <bugprone/inaccurate-erase>`, "Yes"
    :doc:`bugprone-inc-dec-in-conditions <bugprone/inc-dec-in-conditions>`,
-   :doc:`bugprone-inconsistent-ifelse-braces <bugprone/inconsistent-ifelse-braces>`,
+   :doc:`bugprone-inconsistent-ifelse-braces <bugprone/inconsistent-ifelse-braces>`, "Yes"
    :doc:`bugprone-incorrect-enable-if <bugprone/incorrect-enable-if>`, "Yes"
    :doc:`bugprone-incorrect-enable-shared-from-this <bugprone/incorrect-enable-shared-from-this>`, "Yes"
    :doc:`bugprone-incorrect-roundings <bugprone/incorrect-roundings>`,

clang-tools-extra/test/clang-tidy/checkers/bugprone/inconsistent-ifelse-braces.cpp

@@ -120,4 +120,4 @@ void g() {
     do_something("elseif-single-line");
   else
     do_something("else-single-line");
-}
+}