From: wolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Mon, 7 Apr 2003 15:38:04 +0000 (+0000)
Subject: Some doc fixed.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ff3d7ac15da3451852434871402f91e01140a03;p=dealii-svn.git

Some doc fixed.


git-svn-id: https://svn.dealii.org/trunk@7361 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/lac/include/lac/sparse_matrix_ez.h b/deal.II/lac/include/lac/sparse_matrix_ez.h
index 3dcfcb4ccb..dd0d333524 100644
--- a/deal.II/lac/include/lac/sparse_matrix_ez.h
+++ b/deal.II/lac/include/lac/sparse_matrix_ez.h
@@ -358,6 +358,10 @@ class SparseMatrixEZ : public Subscriptor
 				      * properly is essential for an
 				      * efficient assembling of the
 				      * matrix.
+				      *
+				      * The default values are
+				      * @p{default_row_length=5},
+				      * @p{default_increment=4}.
 				      */
     explicit SparseMatrixEZ (const unsigned int n_rows,
 			     const unsigned int n_columns,
@@ -390,6 +394,10 @@ class SparseMatrixEZ : public Subscriptor
 				      * properly is essential for an
 				      * efficient assembling of the
 				      * matrix.
+				      *
+				      * The default values are
+				      * @p{default_row_length=5},
+				      * @p{default_increment=4}.
 				      */
     void reinit (const unsigned int n_rows,
 		 const unsigned int n_columns,
@@ -433,7 +441,7 @@ class SparseMatrixEZ : public Subscriptor
 				      * Set the element @p{(i,j)} to
 				      * @p{value}. Allocates the entry
 				      * if it does not exist. Filters
-				      * out zero automatically.
+				      * out zeroes automatically.
 				      */
     void set (const unsigned int i, const unsigned int j,
 	      const number value);
@@ -442,7 +450,7 @@ class SparseMatrixEZ : public Subscriptor
 				      * Add @p{value} to the element
 				      * @p{(i,j)}. Allocates the entry
 				      * if it does not exist. Filters
-				      * out zero automatically.
+				      * out zeroes automatically.
 				      */
     void add (const unsigned int i, const unsigned int j,
 	      const number value);
diff --git a/deal.II/lac/include/lac/sparse_matrix_ez.templates.h b/deal.II/lac/include/lac/sparse_matrix_ez.templates.h
index ebfe02b78f..47c7750af0 100644
--- a/deal.II/lac/include/lac/sparse_matrix_ez.templates.h
+++ b/deal.II/lac/include/lac/sparse_matrix_ez.templates.h
@@ -70,6 +70,13 @@ SparseMatrixEZ<number>::reinit(const unsigned int n_rows,
 			       unsigned int default_increment)
 {
   clear();
+
+                                   // replace (invalid) default values
+                                   // by true defaults; note that
+                                   // these defaults are also
+                                   // documented in the docs of this
+                                   // function as well as in the docs
+                                   // of the constructor!
   if (default_row_length == Entry::invalid)
     default_row_length = 5;
   if (default_increment == Entry::invalid)