Add documentation to OmpPragma.*

Author: manorom

clang/tools/sotoc/src/OmpPragma.cpp

@@ -1,3 +1,18 @@
+//===-- sotoc/src/TargetCode ------------------------ ---------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+/// This file implements the class OmpPragma, which is used to generate repla-
+/// cement pragmas for teams and team combined constructs.
+///
+//===----------------------------------------------------------------------===//
+
 #include "clang/AST/PrettyPrinter.h"
 
 #include "OmpPragma.h"

clang/tools/sotoc/src/OmpPragma.h

@@ -16,6 +16,20 @@
 
 #include "TargetCodeFragment.h"
 
+/// A helper class to rewrite some "pragma omp" (mostly teams and similar
+/// combined constructs), which are not supported by sotoc.
+/// We currently only support one team to be run on the target because ncc does
+/// not support 'freestanding' teams. So we need to remove teams and
+/// distribute constructs from the generated target code. But teams constructs
+/// can also appear in combined constructs. These combined constructs cannot
+/// simply be removed, they must be replace by "non-team" equivalents to
+/// preserve correctness.
+/// This class provides helper functions that finds a suitable replacement for
+/// omp pragmas that contain teams constructs.
+/// It is used during code generation: The omp pragma of each target region
+/// that is declared as part of a combined construct and each pragma found
+/// during pretty printing is encapsulated by an object of this class which is
+/// then used to generate a replacement.
 class OmpPragma {
   clang::PrintingPolicy PP;
   llvm::ArrayRef<clang::OMPClause *> Clauses;
@@ -28,7 +42,10 @@ class OmpPragma {
   OmpPragma(clang::OMPExecutableDirective *Directive, clang::PrintingPolicy PP)
       : PP(PP), Clauses(Directive->clauses()),
         Kind(Directive->getDirectiveKind()){};
+  /// Returns true if the omp pragma encapsulated, needs to be followed by a
+  /// structured block (i.e. {...}).
   bool needsStructuredBlock();
+  /// Prints a replacement omp pragma for the encapsulated pragma onto \p Out.
   void printReplacement(llvm::raw_ostream &Out);
 
 private: