]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation in one place. 2622/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sat, 21 May 2016 16:39:08 +0000 (11:39 -0500)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sat, 21 May 2016 16:39:08 +0000 (11:39 -0500)
include/deal.II/base/mg_level_object.h

index 5d8f97b884c5947cf57d870241ef719c5f22e01b..71058f9a47866627b120ac8b651ee70946ccbf38 100644 (file)
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------
 //
-// Copyright (C) 2003 - 2015 by the deal.II authors
+// Copyright (C) 2003 - 2016 by the deal.II authors
 //
 // This file is part of the deal.II library.
 //
@@ -106,9 +106,12 @@ public:
   MGLevelObject<Object> &operator = (const double d);
 
   /**
-   * Call @p clear on all objects stored by this object. This function is only
-   * implemented for some @p Object classes, e.g. the PreconditionBlockSOR and
-   * similar classes.
+   * Call @p clear on all objects stored by this object. This function
+   * is only implemented for some @p Object classes, e.g., matrix
+   * types or the PreconditionBlockSOR and similar classes. Using this
+   * function will fail with a compiler error if the @p Object
+   * template type to this class does not provide a
+   * <code>clear()</code> member function.
    */
   void clear();
 

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.