]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add some to the documentation.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 4 Feb 2013 15:10:18 +0000 (15:10 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 4 Feb 2013 15:10:18 +0000 (15:10 +0000)
git-svn-id: https://svn.dealii.org/trunk@28219 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/base/function.h

index fc79c7f79a13ce4b179712ec5cba26f6cdc6329c..e41611040bfa54541df5f054c20889157cbc4ae8 100644 (file)
@@ -1,7 +1,7 @@
 //---------------------------------------------------------------------------
 //    $Id$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2010, 2011, 2012 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2009, 2010, 2011, 2012, 2013 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -590,8 +590,11 @@ protected:
  * components are zero.  It is especially useful as a weight function
  * for VectorTools::integrate_difference, where it allows to
  * integrate only one or a few vector components, rather than the
- * entire vector-valued solution. See the step-20
- * tutorial program for a detailed explanation.
+ * entire vector-valued solution. In other words, it acts as a
+ * component mask with a single component selected (see the
+ * @ref GlossComponentMask "the glossary entry on component masks").
+ * See the step-20
+ * tutorial program for a detailed explanation and a use case.
  *
  * @ingroup functions
  * @author Guido Kanschat, 2000, Wolfgang Bangerth 2006

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.