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
diff --git a/polly/lib/CodeGen/CodeGeneration.cpp b/polly/lib/CodeGen/CodeGeneration.cpp
index 9fd1df7..68b1d83 100644
--- a/polly/lib/CodeGen/CodeGeneration.cpp
+++ b/polly/lib/CodeGen/CodeGeneration.cpp
@@ -53,7 +53,7 @@
CodeGeneration() : ScopPass(ID) {}
- /// @brief The datalayout used
+ /// The datalayout used
const DataLayout *DL;
/// @name The analysis passes we need to generate code.
@@ -96,7 +96,7 @@
}
}
- /// @brief Mark a basic block unreachable.
+ /// Mark a basic block unreachable.
///
/// Marks the basic block @p Block unreachable by equipping it with an
/// UnreachableInst.
@@ -107,7 +107,7 @@
OrigTerminator->eraseFromParent();
}
- /// @brief Generate LLVM-IR for the SCoP @p S.
+ /// Generate LLVM-IR for the SCoP @p S.
bool runOnScop(Scop &S) override {
AI = &getAnalysis<IslAstInfo>();
@@ -198,7 +198,7 @@
return true;
}
- /// @brief Register all analyses and transformation required.
+ /// Register all analyses and transformation required.
void getAnalysisUsage(AnalysisUsage &AU) const override {
AU.addRequired<DominatorTreeWrapperPass>();
AU.addRequired<IslAstInfo>();
diff --git a/polly/lib/CodeGen/IRBuilder.cpp b/polly/lib/CodeGen/IRBuilder.cpp
index 390de8b..cedbe29 100644
--- a/polly/lib/CodeGen/IRBuilder.cpp
+++ b/polly/lib/CodeGen/IRBuilder.cpp
@@ -21,7 +21,7 @@
using namespace llvm;
using namespace polly;
-/// @brief Get a self referencing id metadata node.
+/// Get a self referencing id metadata node.
///
/// The MDNode looks like this (if arg0/arg1 are not null):
///
diff --git a/polly/lib/CodeGen/IslAst.cpp b/polly/lib/CodeGen/IslAst.cpp
index 0152395..4b7cde0 100644
--- a/polly/lib/CodeGen/IslAst.cpp
+++ b/polly/lib/CodeGen/IslAst.cpp
@@ -72,24 +72,24 @@
cl::cat(PollyCategory));
namespace polly {
-/// @brief Temporary information used when building the ast.
+/// Temporary information used when building the ast.
struct AstBuildUserInfo {
- /// @brief Construct and initialize the helper struct for AST creation.
+ /// Construct and initialize the helper struct for AST creation.
AstBuildUserInfo()
: Deps(nullptr), InParallelFor(false), LastForNodeId(nullptr) {}
- /// @brief The dependence information used for the parallelism check.
+ /// The dependence information used for the parallelism check.
const Dependences *Deps;
- /// @brief Flag to indicate that we are inside a parallel for node.
+ /// Flag to indicate that we are inside a parallel for node.
bool InParallelFor;
- /// @brief The last iterator id created for the current SCoP.
+ /// The last iterator id created for the current SCoP.
isl_id *LastForNodeId;
};
} // namespace polly
-/// @brief Free an IslAstUserPayload object pointed to by @p Ptr
+/// Free an IslAstUserPayload object pointed to by @p Ptr.
static void freeIslAstUserPayload(void *Ptr) {
delete ((IslAstInfo::IslAstUserPayload *)Ptr);
}
@@ -99,7 +99,7 @@
isl_pw_aff_free(MinimalDependenceDistance);
}
-/// @brief Print a string @p str in a single line using @p Printer.
+/// Print a string @p str in a single line using @p Printer.
static isl_printer *printLine(__isl_take isl_printer *Printer,
const std::string &str,
__isl_keep isl_pw_aff *PWA = nullptr) {
@@ -110,7 +110,7 @@
return isl_printer_end_line(Printer);
}
-/// @brief Return all broken reductions as a string of clauses (OpenMP style).
+/// Return all broken reductions as a string of clauses (OpenMP style).
static const std::string getBrokenReductionsStr(__isl_keep isl_ast_node *Node) {
IslAstInfo::MemoryAccessSet *BrokenReductions;
std::string str;
@@ -138,7 +138,7 @@
return str;
}
-/// @brief Callback executed for each for node in the ast in order to print it.
+/// Callback executed for each for node in the ast in order to print it.
static isl_printer *cbPrintFor(__isl_take isl_printer *Printer,
__isl_take isl_ast_print_options *Options,
__isl_keep isl_ast_node *Node, void *) {
@@ -165,7 +165,7 @@
return isl_ast_node_for_print(Node, Printer, Options);
}
-/// @brief Check if the current scheduling dimension is parallel
+/// Check if the current scheduling dimension is parallel.
///
/// In case the dimension is parallel we also check if any reduction
/// dependences is broken when we exploit this parallelism. If so,
@@ -371,7 +371,7 @@
return RunCondition;
}
-/// @brief Simple cost analysis for a given SCoP
+/// Simple cost analysis for a given SCoP.
///
/// TODO: Improve this analysis and extract it to make it usable in other
/// places too.
diff --git a/polly/lib/CodeGen/IslExprBuilder.cpp b/polly/lib/CodeGen/IslExprBuilder.cpp
index 30f4b0b..730d2c7 100644
--- a/polly/lib/CodeGen/IslExprBuilder.cpp
+++ b/polly/lib/CodeGen/IslExprBuilder.cpp
@@ -20,7 +20,7 @@
using namespace llvm;
using namespace polly;
-/// @brief Different overflow tracking modes.
+/// Different overflow tracking modes.
enum OverflowTrackingChoice {
OT_NEVER, ///< Never tack potential overflows.
OT_REQUEST, ///< Track potential overflows if requested.
diff --git a/polly/lib/CodeGen/IslNodeBuilder.cpp b/polly/lib/CodeGen/IslNodeBuilder.cpp
index cfd7b53..e5cbbb7 100644
--- a/polly/lib/CodeGen/IslNodeBuilder.cpp
+++ b/polly/lib/CodeGen/IslNodeBuilder.cpp
@@ -106,8 +106,8 @@
return UB;
}
-/// @brief Return true if a return value of Predicate is true for the value
-/// represented by passed isl_ast_expr_int.
+/// Return true if a return value of Predicate is true for the value represented
+/// by passed isl_ast_expr_int.
static bool checkIslAstExprInt(__isl_take isl_ast_expr *Expr,
isl_bool (*Predicate)(__isl_keep isl_val *)) {
if (isl_ast_expr_get_type(Expr) != isl_ast_expr_int) {
@@ -128,7 +128,7 @@
assert(isl_ast_node_get_type(For) == isl_ast_node_for);
auto Body = isl_ast_node_for_get_body(For);
- // First, check if we can actually handle this code
+ // First, check if we can actually handle this code.
switch (isl_ast_node_get_type(Body)) {
case isl_ast_node_user:
break;
@@ -177,7 +177,7 @@
return NumberIterations + 1;
}
-/// @brief Extract the values and SCEVs needed to generate code for a block.
+/// Extract the values and SCEVs needed to generate code for a block.
static int findReferencesInBlock(struct SubtreeReferences &References,
const ScopStmt *Stmt, const BasicBlock *BB) {
for (const Instruction &Inst : *BB)
@@ -487,7 +487,7 @@
isl_id_free(IteratorID);
}
-/// @brief Remove the BBs contained in a (sub)function from the dominator tree.
+/// Remove the BBs contained in a (sub)function from the dominator tree.
///
/// This function removes the basic blocks that are part of a subfunction from
/// the dominator tree. Specifically, when generating code it may happen that at
@@ -904,7 +904,7 @@
return true;
}
-/// @brief Add the number of dimensions in @p BS to @p U.
+/// Add the number of dimensions in @p BS to @p U.
static isl_stat countTotalDims(isl_basic_set *BS, void *U) {
unsigned *NumTotalDim = static_cast<unsigned *>(U);
*NumTotalDim += isl_basic_set_total_dim(BS);