From: bangerth Date: Mon, 27 Dec 2010 22:39:40 +0000 (+0000) Subject: Update documentation in a couple of places. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ab0c0b3cb00f44cc94070e5599449abbba33da57;p=dealii-svn.git Update documentation in a couple of places. git-svn-id: https://svn.dealii.org/trunk@23077 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 0a32db8c24..c761e6dc8b 100644 --- a/deal.II/include/deal.II/base/parameter_handler.h +++ b/deal.II/include/deal.II/base/parameter_handler.h @@ -1194,9 +1194,11 @@ namespace Patterns * *

Reading data from input sources

* - * In order to read input you can use three possibilities: reading from an std::istream object, - * reading from a file of which the name is given and reading from a string in memory in - * which the lines are separated by @\n characters. These possibilites are used as follows: + * In order to read input you can use three possibilities: reading from an + * std::istream object, reading from a file of which the name is + * given and reading from a string in memory in which the lines are + * separated by @\n characters. These possibilites are used as + * follows: * @code * ParameterHandler prm; * ... @@ -1211,15 +1213,18 @@ namespace Patterns * ... * @endcode * You can use several sources of input successively. Entries which are changed more than - * once will be overwritten everytime they are used. It is suggested to let the name of - * parameter input end in .prm. + * once will be overwritten everytime they are used. * * You should not try to declare entries using declare_entry() and * enter_subsection() with as yet unknown subsection names after * using read_input(). The results in this case are unspecified. * - * If an error occurs upon reading the input, error messages are - * written to std::cerr. + * If an error occurs upon reading the input, error messages are written to + * std::cerr and the reader function returns with a return value of + * false. This is opposed to almost all other functions in + * deal.II, which would normally throw an exception if an error occurs; this + * difference in behavior is a relic of the fact that this class predates + * deal.II and had previously been written for a different project. * * *

Getting entry values out of a ParameterHandler object