update documentation

diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h
index 5e26cc3718bf846d34c365c60c2d28f0911f8b90..daa6bbaf92937b27c874ccbf7d6aae1029e40e61 100644 (file)
--- a/include/deal.II/lac/sparsity_pattern.h
+++ b/include/deal.II/lac/sparsity_pattern.h
@@ -397,10 +397,11 @@ public:
   SparsityPattern (const SparsityPattern &);
 
   /**
-   * Initialize a rectangular matrix.
+   * Initialize a rectangular pattern of size <tt>m x n</tt>.
    *
-   * @arg m number of rows @arg n number of columns @arg max_per_row maximum
-   * number of nonzero entries per row
+   * @param[in] m The number of rows.
+   * @param[in] n The number of columns.
+   * @param[in] max_per_row Maximum number of nonzero entries per row.
    */
   SparsityPattern (const size_type m,
                    const size_type n,
@@ -408,35 +409,36 @@ public:
 
 
   /**
-   * Initialize a rectangular matrix.
+   * Initialize a rectangular pattern of size <tt>m x n</tt>.
    *
-   * @arg m number of rows @arg n number of columns @arg row_lengths possible
-   * number of nonzero entries for each row.  This vector must have one entry
-   * for each row.
+   * @param[in] m The number of rows.
+   * @param[in] n The number of columns.
+   * @param[in] row_lengths Possible number of nonzero entries for each row. This
+   * vector must have one entry for each row.
    */
   SparsityPattern (const size_type               m,
                    const size_type               n,
                    const std::vector<unsigned int> &row_lengths);
 
   /**
-   * Initialize a quadratic matrix of dimension <tt>n</tt> with at most
+   * Initialize a quadratic pattern of dimension <tt>m</tt> with at most
    * <tt>max_per_row</tt> nonzero entries per row.
    *
    * This constructor automatically enables optimized storage of diagonal
    * elements. To avoid this, use the constructor taking row and column
    * numbers separately.
    */
-  SparsityPattern (const size_type n,
+  SparsityPattern (const size_type m,
                    const unsigned int max_per_row);
 
   /**
-   * Initialize a quadratic matrix.
+   * Initialize a quadratic pattern of size <tt>m x m</tt>.
    *
-   * @arg m number of rows and columns @arg row_lengths possible number of
-   * nonzero entries for each row.  This vector must have one entry for each
-   * row.
+   * @param[in] m The number of rows and columns.
+   * @param[in] row_lengths Maximum number of nonzero entries for each row. This
+   * vector must have one entry for each row.
    */
-  SparsityPattern (const size_type               m,
+  SparsityPattern (const size_type m,
                    const std::vector<unsigned int> &row_lengths);
 
   /**

diff --git a/source/lac/sparsity_pattern.cc b/source/lac/sparsity_pattern.cc
index 7b5d3f8c9e1a08ebf51316d0a75eea423fa488cb..ebac9b601eca4278f825c10feeadc989cce43401 100644 (file)
--- a/source/lac/sparsity_pattern.cc
+++ b/source/lac/sparsity_pattern.cc
@@ -103,7 +103,7 @@ SparsityPattern::SparsityPattern (const size_type m,
 
 
 
-SparsityPattern::SparsityPattern (const size_type n,
+SparsityPattern::SparsityPattern (const size_type m,
                                   const unsigned int max_per_row)
   :
   max_dim(0),
@@ -111,7 +111,7 @@ SparsityPattern::SparsityPattern (const size_type n,
   rowstart(0),
   colnums(0)
 {
-  reinit (n, n, max_per_row);
+  reinit (m, m, max_per_row);
 }