Drop '@brief' from doxygen comments

LLVM's coding guideline suggests to not use @brief for one-sentence doxygen
comments to improve readability. Switch this once and for all to ensure people
do not copy @brief comments from other parts of Polly, when writing new code.

llvm-svn: 280468

Author: tobiasgrosser

polly/include/polly/Canonicalization.h

@@ -14,7 +14,7 @@
 
 namespace polly {
 
-/// @brief Schedule a set of canonicalization passes to prepare for Polly
+/// Schedule a set of canonicalization passes to prepare for Polly.
 ///
 /// The set of optimization passes was partially taken/copied from the
 /// set of default optimization passes in LLVM. It is used to bring the code

polly/include/polly/CodeGen/BlockGenerators.h

@@ -26,7 +26,7 @@ class ScalarEvolution;
 namespace polly {
 class Scop;
 
-/// @brief Helper class to annotate newly generated SCoPs with metadata.
+/// Helper class to annotate newly generated SCoPs with metadata.
 ///
 /// The annotations are twofold:
 ///   1) Loops are stored in a stack-like structure in the order they are
@@ -44,23 +44,23 @@ class ScopAnnotator {
 public:
   ScopAnnotator();
 
-  /// @brief Build all alias scopes for the given SCoP.
+  /// Build all alias scopes for the given SCoP.
   void buildAliasScopes(Scop &S);
 
-  /// @brief Add a new loop @p L which is parallel if @p IsParallel is true.
+  /// Add a new loop @p L which is parallel if @p IsParallel is true.
   void pushLoop(llvm::Loop *L, bool IsParallel);
 
-  /// @brief Remove the last added loop.
+  /// Remove the last added loop.
   void popLoop(bool isParallel);
 
-  /// @brief Annotate the new instruction @p I for all parallel loops.
+  /// Annotate the new instruction @p I for all parallel loops.
   void annotate(llvm::Instruction *I);
 
-  /// @brief Annotate the loop latch @p B wrt. @p L.
+  /// Annotate the loop latch @p B wrt. @p L.
   void annotateLoopLatch(llvm::BranchInst *B, llvm::Loop *L,
                          bool IsParallel) const;
 
-  /// @brief Add alternative alias based pointers
+  /// Add alternative alias based pointers
   ///
   /// When annotating instructions with alias scope metadata, the right metadata
   /// is identified through the base pointer of the memory access. In some cases
@@ -77,34 +77,34 @@ class ScopAnnotator {
     AlternativeAliasBases.insert(NewMap.begin(), NewMap.end());
   }
 
-  /// @brief Delete the set of alternative alias bases
+  /// Delete the set of alternative alias bases
   void resetAlternativeAliasBases() { AlternativeAliasBases.clear(); }
 
 private:
-  /// @brief The ScalarEvolution analysis we use to find base pointers.
+  /// The ScalarEvolution analysis we use to find base pointers.
   llvm::ScalarEvolution *SE;
 
-  /// @brief All loops currently under construction.
+  /// All loops currently under construction.
   llvm::SmallVector<llvm::Loop *, 8> ActiveLoops;
 
-  /// @brief Metadata pointing to parallel loops currently under construction.
+  /// Metadata pointing to parallel loops currently under construction.
   llvm::SmallVector<llvm::MDNode *, 8> ParallelLoops;
 
-  /// @brief The alias scope domain for the current SCoP.
+  /// The alias scope domain for the current SCoP.
   llvm::MDNode *AliasScopeDomain;
 
-  /// @brief A map from base pointers to its alias scope.
+  /// A map from base pointers to its alias scope.
   llvm::DenseMap<llvm::AssertingVH<llvm::Value>, llvm::MDNode *> AliasScopeMap;
 
-  /// @brief A map from base pointers to an alias scope list of other pointers.
+  /// A map from base pointers to an alias scope list of other pointers.
   llvm::DenseMap<llvm::AssertingVH<llvm::Value>, llvm::MDNode *>
       OtherAliasScopeListMap;
 
   llvm::DenseMap<llvm::AssertingVH<llvm::Value>, llvm::AssertingVH<llvm::Value>>
       AlternativeAliasBases;
 };
 
-/// @brief Add Polly specifics when running IRBuilder.
+/// Add Polly specifics when running IRBuilder.
 ///
 /// This is used to add additional items such as e.g. the llvm.loop.parallel
 /// metadata.
@@ -132,7 +132,7 @@ class IRInserter : protected llvm::IRBuilderDefaultInserter {
 // matches for certain names.
 typedef llvm::IRBuilder<llvm::ConstantFolder, IRInserter> PollyIRBuilder;
 
-/// @brief Return an IR builder pointed before the @p BB terminator.
+/// Return an IR builder pointed before the @p BB terminator.
 static inline PollyIRBuilder createPollyIRBuilder(llvm::BasicBlock *BB,
                                                   ScopAnnotator &LA) {
   PollyIRBuilder Builder(BB->getContext(), llvm::ConstantFolder(),

polly/include/polly/CodeGen/IRBuilder.h

@@ -53,10 +53,10 @@ class IslAst {
 
   __isl_give isl_ast_node *getAst();
 
-  /// @brief Get the run-time conditions for the Scop.
+  /// Get the run-time conditions for the Scop.
   __isl_give isl_ast_expr *getRunCondition();
 
-  /// @brief Build run-time condition for scop.
+  /// Build run-time condition for scop.
   ///
   /// @param S     The scop to build the condition for.
   /// @param Build The isl_build object to use to build the condition.
@@ -79,36 +79,36 @@ class IslAstInfo : public ScopPass {
 public:
   using MemoryAccessSet = SmallPtrSet<MemoryAccess *, 4>;
 
-  /// @brief Payload information used to annotate an AST node.
+  /// Payload information used to annotate an AST node.
   struct IslAstUserPayload {
-    /// @brief Construct and initialize the payload.
+    /// Construct and initialize the payload.
     IslAstUserPayload()
         : IsInnermost(false), IsInnermostParallel(false),
           IsOutermostParallel(false), IsReductionParallel(false),
           MinimalDependenceDistance(nullptr), Build(nullptr) {}
 
-    /// @brief Cleanup all isl structs on destruction.
+    /// Cleanup all isl structs on destruction.
     ~IslAstUserPayload();
 
-    /// @brief Flag to mark innermost loops.
+    /// Flag to mark innermost loops.
     bool IsInnermost;
 
-    /// @brief Flag to mark innermost parallel loops.
+    /// Flag to mark innermost parallel loops.
     bool IsInnermostParallel;
 
-    /// @brief Flag to mark outermost parallel loops.
+    /// Flag to mark outermost parallel loops.
     bool IsOutermostParallel;
 
-    /// @brief Flag to mark parallel loops which break reductions.
+    /// Flag to mark parallel loops which break reductions.
     bool IsReductionParallel;
 
-    /// @brief The minimal dependence distance for non parallel loops.
+    /// The minimal dependence distance for non parallel loops.
     isl_pw_aff *MinimalDependenceDistance;
 
-    /// @brief The build environment at the time this node was constructed.
+    /// The build environment at the time this node was constructed.
     isl_ast_build *Build;
 
-    /// @brief Set of accesses which break reduction dependences.
+    /// Set of accesses which break reduction dependences.
     MemoryAccessSet BrokenReductions;
   };
 
@@ -120,22 +120,22 @@ class IslAstInfo : public ScopPass {
   static char ID;
   IslAstInfo() : ScopPass(ID), S(nullptr), Ast(nullptr) {}
 
-  /// @brief Build the AST for the given SCoP @p S.
+  /// Build the AST for the given SCoP @p S.
   bool runOnScop(Scop &S) override;
 
-  /// @brief Register all analyses and transformation required.
+  /// Register all analyses and transformation required.
   void getAnalysisUsage(AnalysisUsage &AU) const override;
 
-  /// @brief Release the internal memory.
+  /// Release the internal memory.
   void releaseMemory() override;
 
-  /// @brief Print a source code representation of the program.
+  /// Print a source code representation of the program.
   void printScop(llvm::raw_ostream &OS, Scop &S) const override;
 
-  /// @brief Return a copy of the AST root node.
+  /// Return a copy of the AST root node.
   __isl_give isl_ast_node *getAst() const;
 
-  /// @brief Get the run condition.
+  /// Get the run condition.
   ///
   /// Only if the run condition evaluates at run-time to a non-zero value, the
   /// assumptions that have been taken hold. If the run condition evaluates to
@@ -147,38 +147,38 @@ class IslAstInfo : public ScopPass {
   ///
   ///{
 
-  /// @brief Get the complete payload attached to @p Node.
+  /// Get the complete payload attached to @p Node.
   static IslAstUserPayload *getNodePayload(__isl_keep isl_ast_node *Node);
 
-  /// @brief Is this loop an innermost loop?
+  /// Is this loop an innermost loop?
   static bool isInnermost(__isl_keep isl_ast_node *Node);
 
-  /// @brief Is this loop a parallel loop?
+  /// Is this loop a parallel loop?
   static bool isParallel(__isl_keep isl_ast_node *Node);
 
-  /// @brief Is this loop an outermost parallel loop?
+  /// Is this loop an outermost parallel loop?
   static bool isOutermostParallel(__isl_keep isl_ast_node *Node);
 
-  /// @brief Is this loop an innermost parallel loop?
+  /// Is this loop an innermost parallel loop?
   static bool isInnermostParallel(__isl_keep isl_ast_node *Node);
 
-  /// @brief Is this loop a reduction parallel loop?
+  /// Is this loop a reduction parallel loop?
   static bool isReductionParallel(__isl_keep isl_ast_node *Node);
 
-  /// @brief Will the loop be run as thread parallel?
+  /// Will the loop be run as thread parallel?
   static bool isExecutedInParallel(__isl_keep isl_ast_node *Node);
 
-  /// @brief Get the nodes schedule or a nullptr if not available.
+  /// Get the nodes schedule or a nullptr if not available.
   static __isl_give isl_union_map *getSchedule(__isl_keep isl_ast_node *Node);
 
-  /// @brief Get minimal dependence distance or nullptr if not available.
+  /// Get minimal dependence distance or nullptr if not available.
   static __isl_give isl_pw_aff *
   getMinimalDependenceDistance(__isl_keep isl_ast_node *Node);
 
-  /// @brief Get the nodes broken reductions or a nullptr if not available.
+  /// Get the nodes broken reductions or a nullptr if not available.
   static MemoryAccessSet *getBrokenReductions(__isl_keep isl_ast_node *Node);
 
-  /// @brief Get the nodes build context or a nullptr if not available.
+  /// Get the nodes build context or a nullptr if not available.
   static __isl_give isl_ast_build *getBuild(__isl_keep isl_ast_node *Node);
 
   ///}

polly/include/polly/CodeGen/IslAst.h

@@ -41,7 +41,7 @@ template <> class PointerLikeTypeTraits<isl_id *> {
 namespace polly {
 class ScopArrayInfo;
 
-/// @brief LLVM-IR generator for isl_ast_expr[essions]
+/// LLVM-IR generator for isl_ast_expr[essions]
 ///
 /// This generator generates LLVM-IR that performs the computation described by
 /// an isl_ast_expr[ession].
@@ -90,12 +90,12 @@ class ScopArrayInfo;
 ///
 class IslExprBuilder {
 public:
-  /// @brief A map from isl_ids to llvm::Values.
+  /// A map from isl_ids to llvm::Values.
   typedef llvm::MapVector<isl_id *, llvm::AssertingVH<llvm::Value>> IDToValueTy;
 
   typedef llvm::MapVector<isl_id *, const ScopArrayInfo *> IDToScopArrayInfoTy;
 
-  /// @brief A map from isl_ids to ScopArrayInfo objects.
+  /// A map from isl_ids to ScopArrayInfo objects.
   ///
   /// This map is used to obtain ScopArrayInfo objects for isl_ids which do not
   /// carry a ScopArrayInfo object in their user pointer. This is useful if the
@@ -107,12 +107,12 @@ class IslExprBuilder {
   /// code generation.
   IDToScopArrayInfoTy *IDToSAI = nullptr;
 
-  /// @brief Set the isl_id to ScopArrayInfo map.
+  /// Set the isl_id to ScopArrayInfo map.
   ///
   /// @param NewIDToSAI The new isl_id to ScopArrayInfo map to use.
   void setIDToSAI(IDToScopArrayInfoTy *NewIDToSAI) { IDToSAI = NewIDToSAI; }
 
-  /// @brief Construct an IslExprBuilder.
+  /// Construct an IslExprBuilder.
   ///
   /// @param Builder The IRBuilder used to construct the isl_ast_expr[ession].
   ///                The insert location of this IRBuilder defines WHERE the
@@ -127,22 +127,22 @@ class IslExprBuilder {
                  llvm::ScalarEvolution &SE, llvm::DominatorTree &DT,
                  llvm::LoopInfo &LI);
 
-  /// @brief Create LLVM-IR for an isl_ast_expr[ession].
+  /// Create LLVM-IR for an isl_ast_expr[ession].
   ///
   /// @param Expr The ast expression for which we generate LLVM-IR.
   ///
   /// @return The llvm::Value* containing the result of the computation.
   llvm::Value *create(__isl_take isl_ast_expr *Expr);
 
-  /// @brief Return the largest of two types.
+  /// Return the largest of two types.
   ///
   /// @param T1 The first type.
   /// @param T2 The second type.
   ///
   /// @return The largest of the two types.
   llvm::Type *getWidestType(llvm::Type *T1, llvm::Type *T2);
 
-  /// @brief Return the type with which this expression should be computed.
+  /// Return the type with which this expression should be computed.
   ///
   /// The type needs to be large enough to hold all possible input and all
   /// possible output values.
@@ -151,15 +151,15 @@ class IslExprBuilder {
   /// @return The type with which the expression should be computed.
   llvm::IntegerType *getType(__isl_keep isl_ast_expr *Expr);
 
-  /// @brief Change if runtime overflows are tracked or not.
+  /// Change if runtime overflows are tracked or not.
   ///
   /// @param Enable Flag to enable/disable the tracking.
   ///
   /// Note that this will reset the tracking state and that tracking is only
   /// allowed if the last tracked expression dominates the current insert point.
   void setTrackOverflow(bool Enable);
 
-  /// @brief Return the current overflow status or nullptr if it is not tracked.
+  /// Return the current overflow status or nullptr if it is not tracked.
   ///
   /// @return A nullptr if tracking is disabled or otherwise an i1 that has the
   ///         value of "0" if and only if no overflow happened since tracking
@@ -169,7 +169,7 @@ class IslExprBuilder {
 private:
   Scop &S;
 
-  /// @brief Flag that will be set if an overflow occurred at runtime.
+  /// Flag that will be set if an overflow occurred at runtime.
   ///
   /// Note that this flag is by default a nullptr and if it is a nullptr
   /// we will not record overflows but simply perform the computations.
@@ -205,7 +205,7 @@ class IslExprBuilder {
   llvm::Value *createOpAddressOf(__isl_take isl_ast_expr *Expr);
   llvm::Value *createAccessAddress(__isl_take isl_ast_expr *Expr);
 
-  /// @brief Create a binary operation @p Opc and track overflows if requested.
+  /// Create a binary operation @p Opc and track overflows if requested.
   ///
   /// @param OpC  The binary operation that should be performed [Add/Sub/Mul].
   /// @param LHS  The left operand.
@@ -217,7 +217,7 @@ class IslExprBuilder {
                            llvm::Value *LHS, llvm::Value *RHS,
                            const llvm::Twine &Name);
 
-  /// @brief Create an addition and track overflows if requested.
+  /// Create an addition and track overflows if requested.
   ///
   /// @param LHS  The left operand.
   /// @param RHS  The right operand.
@@ -227,7 +227,7 @@ class IslExprBuilder {
   llvm::Value *createAdd(llvm::Value *LHS, llvm::Value *RHS,
                          const llvm::Twine &Name = "");
 
-  /// @brief Create a subtraction and track overflows if requested.
+  /// Create a subtraction and track overflows if requested.
   ///
   /// @param LHS  The left operand.
   /// @param RHS  The right operand.
@@ -237,7 +237,7 @@ class IslExprBuilder {
   llvm::Value *createSub(llvm::Value *LHS, llvm::Value *RHS,
                          const llvm::Twine &Name = "");
 
-  /// @brief Create a multiplication and track overflows if requested.
+  /// Create a multiplication and track overflows if requested.
   ///
   /// @param LHS  The left operand.
   /// @param RHS  The right operand.