]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Elaborate on the continuation line comment.
authorDavid Wells <wellsd2@rpi.edu>
Mon, 25 Jan 2016 03:28:52 +0000 (22:28 -0500)
committerDavid Wells <wellsd2@rpi.edu>
Mon, 25 Jan 2016 03:44:53 +0000 (22:44 -0500)
include/deal.II/base/parameter_handler.h

index 9f37c091fe33bdfebd9c17bfa1611574da565201..d0c9db88e353a32e94539b9b150f23d7fd01d9eb 100644 (file)
@@ -1016,8 +1016,11 @@ namespace Patterns
  *
  * Comments starting with \# are skipped.
  *
- * Continuation lines are allowed by means of the character <tt>\\</tt>,
- * which must be the last character of the line.
+ * Continuation lines are allowed by means of the character <tt>\\</tt>, which
+ * must be the last character (aside from whitespace, which is ignored) of the
+ * line. When a line is a continuation (i.e., the previous line ended in a
+ * <tt>\\</tt>), then, unlike the default behavior of the <tt>C</tt>
+ * preprocessor, all whitespace at the beginning of the line is ignored.
  *
  * We propose to use the following scheme to name entries: start the first
  * word with a capital letter and use lowercase letters further on. The same

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.