r338245 - [clang-format] Silence -Wdocumentation warnings

[Krasimir Georgiev via cfe-commits]

Author: krasimir
Date: Mon Jul 30 05:22:41 2018
New Revision: 338245

URL: http://llvm.org/viewvc/llvm-project?rev=338245&view=rev
Log:
[clang-format] Silence -Wdocumentation warnings

introduced in r338232

Modified:
    cfe/trunk/lib/Format/BreakableToken.h

Modified: cfe/trunk/lib/Format/BreakableToken.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Format/BreakableToken.h?rev=338245&r1=338244&r2=338245&view=diff
==============================================================================
--- cfe/trunk/lib/Format/BreakableToken.h (original)
+++ cfe/trunk/lib/Format/BreakableToken.h Mon Jul 30 05:22:41 2018
@@ -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;
   }