Update documentation in a couple of places.

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

diff --git a/deal.II/include/deal.II/base/parameter_handler.h b/deal.II/include/deal.II/base/parameter_handler.h
index f19849ef969d18ff37b38f28734cdb594e4a7d97..7d1a7ba379e1de71061120718d947301e21322a4 100644 (file)
--- a/deal.II/include/deal.II/base/parameter_handler.h
+++ b/deal.II/include/deal.II/base/parameter_handler.h
@@ -1,7 +1,7 @@
 //---------------------------------------------------------------------------
 //    $Id$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 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
@@ -1701,7 +1701,7 @@ namespace Patterns
  *     prm.leave_subsection ();
  *   @endcode
  *
- *   We can think of the parameters so arrange as a file system in which every
+ *   We can think of the parameters so arranged as a file system in which every
  *   parameter is a directory. The name of this directory is the name of the
  *   parameter, and in this directory lie files that describe the
  *   parameter. These files are:
@@ -1713,7 +1713,7 @@ namespace Patterns
  *   - <code>pattern</code>: A textual representation of the pattern that describes
  *     the parameter's possible values.
  *   - <code>pattern_index</code>: A number that indexes the Patterns::PatternBase
- *     object that is used to to describe the parameter.
+ *     object that is used to describe the parameter.
  *   - <code>documentation</code>: The content of this file is the documentation
  *     given for a parameter as the last argument of the
  *     ParameterHandler::declare_entry call.
@@ -1769,9 +1769,14 @@ namespace Patterns
  *   This representation closely resembles the directory/file structure
  *   discussed above. The only difference is that directory and file
  *   names are mangled: since they should only contain letters and
- *   numbers, every character in their names that's not one is replaced
+ *   numbers, every character in their names that is not a letter or number
+ *   is replaced
  *   by an underscore followed by its two-digit hexadecimal representation.
- *   In addition, the entire tree is wrapped into a tag
+ *   In addition, the special names "value", "default_value", "pattern",
+ *   "pattern_index", and "documentation" are mangled when used as
+ *   names of parameters given that these names are also used to name
+ *   special files in the hierarchy structure.
+ *   Finally, the entire tree is wrapped into a tag
  *   <code>%ParameterHandler</code> to satisfy the XML requirement that there
  *   be only a single top-level construct in each file.
  *