From adf65f1e4587c5e232916d424f98f67e0ccd607b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20Gr=C3=BCninger?= <gruenich@dune-project.org>
Date: Sat, 26 May 2012 09:46:13 +0000
Subject: [PATCH] [Documentation] Fixed some Doxygen issues.
[[Imported from SVN: r1600]]
---
dune/istl/bvector.hh | 2 +-
dune/istl/io.hh | 2 +-
dune/istl/matrixmarket.hh | 4 ++--
dune/istl/overlappingschwarz.hh | 35 +++++++++++++++++----------------
dune/istl/paamg/hierarchy.hh | 2 +-
dune/istl/repartition.hh | 4 ++--
6 files changed, 25 insertions(+), 24 deletions(-)
diff --git a/dune/istl/bvector.hh b/dune/istl/bvector.hh
index 64ec12e48..0339b8add 100644
--- a/dune/istl/bvector.hh
+++ b/dune/istl/bvector.hh
@@ -372,7 +372,7 @@ namespace Dune {
/**
* @brief Resize the vector.
*
- * After calling this method ::N() will return size
+ * After calling this method BlockVector::N() will return size
* If the capacity of the vector is smaller than the specified
* size then reserve(size) will be called.
*
diff --git a/dune/istl/io.hh b/dune/istl/io.hh
index 3927747be..6d611b926 100644
--- a/dune/istl/io.hh
+++ b/dune/istl/io.hh
@@ -469,7 +469,7 @@ namespace Dune {
* \code
new_mat = spconvert(load('filename'));
* \endcode
- * @param reference to matrix
+ * @param matrix reference to matrix
* @param filename
* @param outputPrecision (number of digits) which is used to write the output file
*/
diff --git a/dune/istl/matrixmarket.hh b/dune/istl/matrixmarket.hh
index 325aad21a..4249d170a 100644
--- a/dune/istl/matrixmarket.hh
+++ b/dune/istl/matrixmarket.hh
@@ -764,8 +764,8 @@ namespace Dune
/**
- * @brief Reads a sparse matrix from a matrix market file.
- * @param matrix The matrix to store the data in.
+ * @brief Reads a BlockVector from a matrix market file.
+ * @param vector The vector to store the data in.
* @param istr The input stream to read the data from.
* @warning Not all formats are supported!
*/
diff --git a/dune/istl/overlappingschwarz.hh b/dune/istl/overlappingschwarz.hh
index ad6c95c50..5358b895c 100644
--- a/dune/istl/overlappingschwarz.hh
+++ b/dune/istl/overlappingschwarz.hh
@@ -168,7 +168,7 @@ namespace Dune
/**
* @brief Set the data of the local problem.
*
- * @param A The global matrix.
+ * @param BCRS The global matrix.
* @param rowset The global indices of the local problem.
* @tparam S The type of the set with the indices.
*/
@@ -220,10 +220,10 @@ namespace Dune
/**
* @brief Constructor.
- * @param mat The global matrix.
- * @param rhs storage for the local defect.
- * @param b the global right hand side.
- * @param x the global left hand side.
+ * @param maxlength The maximum entries over all subdomains.
+ * @param mat_ The global matrix.
+ * @param b_ the global right hand side.
+ * @param x_ the global left hand side.
*/
OverlappingAssigner(std::size_t maxlength, const BCRSMatrix<FieldMatrix<K,n,n>, Al>& mat_, const X& b_, Y& x_);
@@ -233,7 +233,7 @@ namespace Dune
inline
void deallocate();
- /*
+ /**
* @brief Resets the local index to zero.
*/
inline
@@ -262,7 +262,7 @@ namespace Dune
/**
* @brief calculate one entry of the local defect.
- * @param domain One index of the domain.
+ * @param domainIndex One index of the domain.
*/
void operator()(const size_type& domainIndex);
@@ -310,8 +310,8 @@ namespace Dune
/**
* @brief Constructor.
+ * @param maxlength The maximum entries over all subdomains.
* @param mat The global matrix.
- * @param rhs storage for the local defect.
* @param b the global right hand side.
* @param x the global left hand side.
*/
@@ -396,8 +396,8 @@ namespace Dune
typedef typename matrix_type::size_type size_type;
/**
* @brief Constructor.
+ * @param maxlength The maximum entries over all subdomains.
* @param mat The global matrix.
- * @param rhs storage for the local defect.
* @param b the global right hand side.
* @param x the global left hand side.
*/
@@ -410,13 +410,14 @@ namespace Dune
*/
void deallocate();
- /*
+ /**
* @brief Resets the local index to zero.
*/
void resetIndexForNextDomain();
- /*
- * @brief Resets the local index to zero.
+ /**
+ * @brief Get the local left hand side.
+ * @return The local left hand side.
*/
X& lhs();
@@ -472,8 +473,8 @@ namespace Dune
public:
/**
* @brief Constructor.
+ * @param maxlength The maximum entries over all subdomains.
* @param mat The global matrix.
- * @param rhs storage for the local defect.
* @param b the global right hand side.
* @param x the global left hand side.
*/
@@ -491,8 +492,8 @@ namespace Dune
public:
/**
* @brief Constructor.
+ * @param maxlength The maximum entries over all subdomains.
* @param mat The global matrix.
- * @param rhs storage for the local defect.
* @param b the global right hand side.
* @param x the global left hand side.
*/
@@ -546,7 +547,7 @@ namespace Dune
*
* There are specialization for the additive, the multiplicative, and the symmetric multiplicative mode.
*
- * \tparam The Schwarz mode (either AdditiveSchwarzMode or MuliplicativeSchwarzMode or
+ * \tparam T The Schwarz mode (either AdditiveSchwarzMode or MuliplicativeSchwarzMode or
* SymmetricMultiplicativeSchwarzMode)
* \tparam X The vector field type
*/
@@ -800,7 +801,7 @@ namespace Dune
* @param subDomains Array of sets of rowindices belonging to an overlapping
* subdomain
* @param relaxationFactor relaxation factor
- * @param onTheFly If true the decomposition of the exact local solvers is
+ * @param onTheFly_ If true the decomposition of the exact local solvers is
* computed on the fly for each subdomain and
* iteration step. If false all decompositions are computed in pre and
* only forward and backward substitution takes place
@@ -815,7 +816,7 @@ namespace Dune
* @param mat The matrix to precondition.
* @param rowToDomain The mapping of the rows onto the domains.
* @param relaxationFactor relaxation factor
- * @param onTheFly If true the decomposition of the exact local solvers is
+ * @param onTheFly_ If true the decomposition of the exact local solvers is
* computed on the fly for each subdomain and
* iteration step. If false all decompositions are computed in pre and
* only forward and backward substitution takes place
diff --git a/dune/istl/paamg/hierarchy.hh b/dune/istl/paamg/hierarchy.hh
index dd9b972d4..494670535 100644
--- a/dune/istl/paamg/hierarchy.hh
+++ b/dune/istl/paamg/hierarchy.hh
@@ -400,7 +400,7 @@ namespace Dune
bool hasCoarsest() const;
/**
- * @brief Whether the hierarchy wis built.
+ * @brief Whether the hierarchy was built.
* @return true if the ::coarsen method was called.
*/
bool isBuilt() const;
diff --git a/dune/istl/repartition.hh b/dune/istl/repartition.hh
index 367d42b09..f9635d925 100644
--- a/dune/istl/repartition.hh
+++ b/dune/istl/repartition.hh
@@ -1206,8 +1206,8 @@ namespace Dune
* @param nparts The number of domains the repartitioning should achieve.
* @param[out] outcomm Pointer store the parallel information of the
* redistributed domains in.
- * @param[out] datari Pointer to store the remote index information
- * for send the data from the original partitioning to the new one in.
+ * @param redistInf Redistribute interface
+ * @param verbose Verbosity flag to give out additional information.
*/
template<class G, class T1, class T2>
bool graphRepartition(const G& graph, Dune::OwnerOverlapCopyCommunication<T1,T2>& oocomm, int nparts,
--
GitLab