From: Krasimir Georgiev <krasimir@google.com>
Date: Mon, 30 Jul 2018 12:22:41 +0000 (+0000)
Subject: [clang-format] Silence -Wdocumentation warnings
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fc8388f1fbbca891c016e50dd261c1db384ad82c;p=clang

[clang-format] Silence -Wdocumentation warnings

introduced in r338232

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@338245 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/lib/Format/BreakableToken.h b/lib/Format/BreakableToken.h
index a2a818f911..10e1801780 100644
--- a/lib/Format/BreakableToken.h
+++ b/lib/Format/BreakableToken.h
@@ -139,12 +139,14 @@ public:
   /// Returns additional content indent required for the second line after the
   /// content at line \p LineIndex is broken.
   ///
-  /// For example, Javadoc @param annotations require and indent of 4 spaces and
-  /// in this example getContentIndex(1) returns 4.
-  /// /**
-  ///  * @param loooooooooooooong line
-  ///  *     continuation
-  ///  */
+  // (Next lines do not start with `///` since otherwise -Wdocumentation picks
+  // up the example annotations and generates warnings for them)
+  // For example, Javadoc @param annotations require and indent of 4 spaces and
+  // in this example getContentIndex(1) returns 4.
+  // /**
+  //  * @param loooooooooooooong line
+  //  *     continuation
+  //  */
   virtual unsigned getContentIndent(unsigned LineIndex) const {
     return 0;
   }