From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Mon, 1 Dec 2014 02:27:22 +0000 (-0600)
Subject: Update documentation in one place.
X-Git-Tag: v8.2.0-rc1~37^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a4544a4b7acdaf62f595a25300f72c2ea70f1b7c;p=dealii.git

Update documentation in one place.
---

diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h
index c87fd6c19e..71203e9953 100644
--- a/include/deal.II/base/symmetric_tensor.h
+++ b/include/deal.II/base/symmetric_tensor.h
@@ -2369,7 +2369,8 @@ deviator (const SymmetricTensor<2,dim,Number> &t)
 
 
 /**
- * Return a unit symmetric tensor of rank 2.
+ * Return a unit symmetric tensor of rank 2, i.e., the dim-by-dim
+ * identity matrix.
  *
  * @relates SymmetricTensor
  * @author Wolfgang Bangerth, 2005
@@ -2379,6 +2380,8 @@ inline
 SymmetricTensor<2,dim,Number>
 unit_symmetric_tensor ()
 {
+  // create a default constructed matrix filled with
+  // zeros, then set the diagonal elements to one
   SymmetricTensor<2,dim,Number> tmp;
   switch (dim)
     {
@@ -2401,7 +2404,9 @@ unit_symmetric_tensor ()
 
 
 /**
- * Return a unit symmetric tensor of rank 2 for double tensor.
+ * Return a unit symmetric tensor of rank 2, i.e., the dim-by-dim
+ * identity matrix. This specialization of the function uses
+ * <code>double</code> as the data type for the elements.
  *
  * @relates SymmetricTensor
  * @author Wolfgang Bangerth, 2005