[llvm] r335468 - [IR] avoid -Wdocumentation spew about HTML tags

Sanjay Patel via llvm-commits llvm-commits at lists.llvm.org
Mon Jun 25 06:40:54 PDT 2018


Author: spatel
Date: Mon Jun 25 06:40:54 2018
New Revision: 335468

URL: http://llvm.org/viewvc/llvm-project?rev=335468&view=rev
Log:
[IR] avoid -Wdocumentation spew about HTML tags

There's probably a better solution, but adding spaces
in the IR vector examples sidesteps the problem without
uglifying the plain text. 

Modified:
    llvm/trunk/include/llvm/IR/Instructions.h

Modified: llvm/trunk/include/llvm/IR/Instructions.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/IR/Instructions.h?rev=335468&r1=335467&r2=335468&view=diff
==============================================================================
--- llvm/trunk/include/llvm/IR/Instructions.h (original)
+++ llvm/trunk/include/llvm/IR/Instructions.h Mon Jun 25 06:40:54 2018
@@ -2584,12 +2584,12 @@ public:
   /// For example, a simple 2x2 matrix can be transposed with:
   ///
   ///   ; Original matrix
-  ///   m0 = <a, b>
-  ///   m1 = <c, d>
+  ///   m0 = < a, b >
+  ///   m1 = < c, d >
   ///
   ///   ; Transposed matrix
-  ///   t0 = <a, c> = shufflevector m0, m1, <0, 2>
-  ///   t1 = <b, d> = shufflevector m0, m1, <1, 3>
+  ///   t0 = < a, c > = shufflevector m0, m1, < 0, 2 >
+  ///   t1 = < b, d > = shufflevector m0, m1, < 1, 3 >
   ///
   /// For matrices having greater than n columns, the resulting nx2 transposed
   /// matrix is stored in two result vectors such that one vector contains
@@ -2598,12 +2598,12 @@ public:
   /// a 2x4 matrix can be transposed with:
   ///
   ///   ; Original matrix
-  ///   m0 = <a, b, c, d>
-  ///   m1 = <e, f, g, h>
+  ///   m0 = < a, b, c, d >
+  ///   m1 = < e, f, g, h >
   ///
   ///   ; Transposed matrix
-  ///   t0 = <a, e, c, g> = shufflevector m0, m1 <0, 4, 2, 6>
-  ///   t1 = <b, f, d, h> = shufflevector m0, m1 <1, 5, 3, 7>
+  ///   t0 = < a, e, c, g > = shufflevector m0, m1 < 0, 4, 2, 6 >
+  ///   t1 = < b, f, d, h > = shufflevector m0, m1 < 1, 5, 3, 7 >
   static bool isTransposeMask(ArrayRef<int> Mask);
   static bool isTransposeMask(const Constant *Mask) {
     assert(Mask->getType()->isVectorTy() && "Shuffle needs vector constant.");




More information about the llvm-commits mailing list