From 2f31a38f31365922f3f030ad743d4bb134aa565a Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sat, 21 May 2016 11:39:08 -0500 Subject: [PATCH] Update documentation in one place. --- include/deal.II/base/mg_level_object.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/include/deal.II/base/mg_level_object.h b/include/deal.II/base/mg_level_object.h index 5d8f97b884..71058f9a47 100644 --- a/include/deal.II/base/mg_level_object.h +++ b/include/deal.II/base/mg_level_object.h @@ -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 &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 + * clear() member function. */ void clear(); -- 2.39.5