From e2666da1dd5daa5e2fce490328e76fa4361c5362 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20Gr=C3=BCninger?= <gruenich@dune-project.org>
Date: Thu, 21 Mar 2013 22:18:47 +0000
Subject: [PATCH] [Doxygen] Fix most of the Doxygen warnings. Four warnings are
left for two variables - I don't know what they do.
[[Imported from SVN: r1908]]
---
dune/istl/paamg/aggregates.hh | 4 ++++
dune/istl/paamg/amg.hh | 2 ++
dune/istl/paamg/fastamg.hh | 3 ++-
dune/istl/paamg/hierarchy.hh | 2 +-
dune/istl/solvers.hh | 4 +++-
5 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/dune/istl/paamg/aggregates.hh b/dune/istl/paamg/aggregates.hh
index 7f2effa60..769a76023 100644
--- a/dune/istl/paamg/aggregates.hh
+++ b/dune/istl/paamg/aggregates.hh
@@ -761,6 +761,7 @@ namespace Dune
* @param aggregates The mapping of vertices onto aggregates.
* @param connectivity The set of vertices connected to the aggregate.
* distance spheres.
+ * @param front_ The vertices of the current aggregate front.
*/
Aggregate(MatrixGraph& graph, AggregatesMap<Vertex>& aggregates,
VertexSet& connectivity, std::vector<Vertex>& front_);
@@ -841,6 +842,9 @@ namespace Dune
*/
VertexSet& connected_;
+ /**
+ * @brief The vertices of the current aggregate front.
+ */
std::vector<Vertex>& front_;
};
diff --git a/dune/istl/paamg/amg.hh b/dune/istl/paamg/amg.hh
index 43bbceac9..8fbdad3ec 100644
--- a/dune/istl/paamg/amg.hh
+++ b/dune/istl/paamg/amg.hh
@@ -105,6 +105,7 @@ namespace Dune
* @param gamma The number of subcycles. 1 for V-cycle, 2 for W-cycle.
* @param preSmoothingSteps The number of smoothing steps for premoothing.
* @param postSmoothingSteps The number of smoothing steps for postmoothing.
+ * @param additive Whether to use additive multigrid.
* @deprecated Use constructor
* AMG(const OperatorHierarchy&, CoarseSolver&, const SmootherArgs, const Parameters&)
* instead.
@@ -140,6 +141,7 @@ namespace Dune
* @param gamma 1 for V-cycle, 2 for W-cycle
* @param preSmoothingSteps The number of smoothing steps for premoothing.
* @param postSmoothingSteps The number of smoothing steps for postmoothing.
+ * @param additive Whether to use additive multigrid.
* @param pinfo The information about the parallel distribution of the data.
* @deprecated Use
* AMG(const Operator&, const C&, const SmootherArgs, const ParallelInformation)
diff --git a/dune/istl/paamg/fastamg.hh b/dune/istl/paamg/fastamg.hh
index 8bd410a98..ea1f93be2 100644
--- a/dune/istl/paamg/fastamg.hh
+++ b/dune/istl/paamg/fastamg.hh
@@ -103,11 +103,12 @@ namespace Dune
* @param fineOperator The operator on the fine level.
* @param criterion The criterion describing the coarsening strategy. E. g. SymmetricCriterion
* or UnsymmetricCriterion, and providing the parameters.
+ * @param parms The parameters for the AMG.
* @param pinfo The information about the parallel distribution of the data.
*/
template<class C>
FastAMG(const Operator& fineOperator, const C& criterion,
- const Parameters& params,
+ const Parameters& parms,
bool symmetric=true,
const ParallelInformation& pinfo=ParallelInformation());
diff --git a/dune/istl/paamg/hierarchy.hh b/dune/istl/paamg/hierarchy.hh
index a1957ecc0..a1d54c047 100644
--- a/dune/istl/paamg/hierarchy.hh
+++ b/dune/istl/paamg/hierarchy.hh
@@ -401,7 +401,7 @@ namespace Dune
/**
* @brief Whether the hierarchy was built.
- * @return true if the ::coarsen method was called.
+ * @return true if the MatrixHierarchy::build method was called.
*/
bool isBuilt() const;
diff --git a/dune/istl/solvers.hh b/dune/istl/solvers.hh
index 434d58280..64be4dd67 100644
--- a/dune/istl/solvers.hh
+++ b/dune/istl/solvers.hh
@@ -1511,7 +1511,9 @@ namespace Dune {
/*!
\brief Set up nonlinear preconditioned conjugate gradient solver.
- \copydoc LoopSolver::LoopSolver(L&,S&P&,double,int,int)
+ \copydoc LoopSolver::LoopSolver(L&,S&,P&,double,int,int)
+ \param restart When to restart the construction of
+ the Krylov search space.
*/
template<class L, class P, class S>
GeneralizedPCGSolver (L& op, S& sp, P& prec,
--
GitLab