[MLIR][SCF] Improve doc (NFC)

llvm · Jun 8, 2022 · d484797 · d484797
1 parent 7207373
commit d484797
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/mlir/include/mlir/Dialect/SCF/SCFOps.td b/mlir/include/mlir/Dialect/SCF/SCFOps.td
@@ -111,6 +111,10 @@ def ExecuteRegionOp : SCF_Op<"execute_region", [
   let hasVerifier = 1;
 }
 
+//===----------------------------------------------------------------------===//
+// ForOp
+//===----------------------------------------------------------------------===//
+
 def ForOp : SCF_Op<"for",
       [AutomaticAllocationScope, DeclareOpInterfaceMethods<LoopLikeOpInterface,
        ["getSingleInductionVar", "getSingleLowerBound", "getSingleStep",
@@ -427,6 +431,10 @@ def ForeachThreadOp : SCF_Op<"foreach_thread", [
   }];
 }
 
+//===----------------------------------------------------------------------===//
+// PerformConcurrentlyOp
+//===----------------------------------------------------------------------===//
+
 def PerformConcurrentlyOp : SCF_Op<"foreach_thread.perform_concurrently", [
        NoSideEffect,
        Terminator,
@@ -462,6 +470,10 @@ def PerformConcurrentlyOp : SCF_Op<"foreach_thread.perform_concurrently", [
   }];
 }
 
+//===----------------------------------------------------------------------===//
+// ParallelInsertSliceOp
+//===----------------------------------------------------------------------===//
+
 // TODO: Implement PerformConcurrentlyOpInterface.
 def ParallelInsertSliceOp : SCF_Op<"foreach_thread.parallel_insert_slice", [
        AttrSizedOperandSegments,
@@ -652,6 +664,10 @@ def IfOp : SCF_Op<"if",
   let hasVerifier = 1;
 }
 
+//===----------------------------------------------------------------------===//
+// ParallelOp
+//===----------------------------------------------------------------------===//
+
 def ParallelOp : SCF_Op<"parallel",
     [AutomaticAllocationScope,
      AttrSizedOperandSegments,
@@ -736,6 +752,10 @@ def ParallelOp : SCF_Op<"parallel",
   let hasVerifier = 1;
 }
 
+//===----------------------------------------------------------------------===//
+// ReduceOp
+//===----------------------------------------------------------------------===//
+
 def ReduceOp : SCF_Op<"reduce", [HasParent<"ParallelOp">]> {
   let summary = "reduce operation for parallel for";
   let description = [{
@@ -786,6 +806,10 @@ def ReduceOp : SCF_Op<"reduce", [HasParent<"ParallelOp">]> {
   let hasRegionVerifier = 1;
 }
 
+//===----------------------------------------------------------------------===//
+// ReduceReturnOp
+//===----------------------------------------------------------------------===//
+
 def ReduceReturnOp :
     SCF_Op<"reduce.return", [HasParent<"ReduceOp">, NoSideEffect,
                               Terminator]> {
@@ -805,6 +829,10 @@ def ReduceReturnOp :
   let hasVerifier = 1;
 }
 
+//===----------------------------------------------------------------------===//
+// WhileOp
+//===----------------------------------------------------------------------===//
+
 def WhileOp : SCF_Op<"while",
     [DeclareOpInterfaceMethods<RegionBranchOpInterface>,
      RecursiveSideEffects]> {
@@ -939,6 +967,10 @@ def WhileOp : SCF_Op<"while",
   let hasRegionVerifier = 1;
 }
 
+//===----------------------------------------------------------------------===//
+// YieldOp
+//===----------------------------------------------------------------------===//
+
 def YieldOp : SCF_Op<"yield", [NoSideEffect, ReturnLike, Terminator,
                                ParentOneOf<["ExecuteRegionOp, ForOp",
                                             "IfOp, ParallelOp, WhileOp"]>]> {