diff options
Diffstat (limited to 'test/unit/memory.h')
-rw-r--r-- | test/unit/memory.h | 52 |
1 files changed, 24 insertions, 28 deletions
diff --git a/test/unit/memory.h b/test/unit/memory.h index 45c65c202..68982077c 100644 --- a/test/unit/memory.h +++ b/test/unit/memory.h @@ -1,31 +1,27 @@ -/********************* */ -/*! \file memory.h - ** \verbatim - ** Top contributors (to current version): - ** Tim King, Morgan Deters, Aina Niemetz - ** This file is part of the CVC4 project. - ** Copyright (c) 2009-2021 by the authors listed in the file AUTHORS - ** in the top-level source directory and their institutional affiliations. - ** All rights reserved. See the file COPYING in the top-level source - ** directory for licensing information.\endverbatim - ** - ** \brief Utility class to help testing out-of-memory conditions. - ** - ** Utility class to help testing out-of-memory conditions. - ** - ** Use it like this (for example): - ** - ** cvc5::test::WithLimitedMemory wlm(amount); - ** TS_ASSERT_THROWS( foo(), bad_alloc ); - ** - ** The WithLimitedMemory destructor will re-establish the previous limit. - ** - ** This class does not exist in CVC5_MEMORY_LIMITING_DISABLED is defined. - ** This can be disabled for a variety of reasons. - ** If this is disabled, there will be a function: - ** void WarnWithLimitedMemoryDisabledReason() - ** uses TS_WARN to alert users that these tests are disabled. - **/ +/****************************************************************************** + * Top contributors (to current version): + * Tim King, Morgan Deters, Aina Niemetz + * + * This file is part of the cvc5 project. + * + * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS + * in the top-level source directory and their institutional affiliations. + * All rights reserved. See the file COPYING in the top-level source + * directory for licensing information. + * **************************************************************************** + * + * Utility class to help testing out-of-memory conditions. + * + * Use it like this (for example): + * + * cvc5::test::WithLimitedMemory wlm(amount); + * ASSERT_THROW( foo(), bad_alloc ); + * + * The WithLimitedMemory destructor will re-establish the previous limit. + * + * This class does not exist in CVC4_MEMORY_LIMITING_DISABLED is defined. + * This can be disabled for a variety of reasons. + */ #include "test.h" |