0031363: Documentation - broken Doxygen documentation of header files in Standard...
[occt.git] / src / Standard / Standard_WarningsRestore.hxx
1 // Copyright (c) 2018 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 //!@file
15 //! Restores compiler warnings suppressed by inclusion of Standard_WarningsDisable.hxx.
16 //!
17 //! Standard_WarningsDisable.hxx disables all compiler warnings.
18 //! Standard_WarningsRestore.hxx restore the previous state of warnings.
19 //!
20 //! Use these headers to wrap include directive containing external (non-OCCT) 
21 //! header files to avoid compiler warnings to be generated for these files.
22 //! They should always be used in pair:
23 //!
24 //! @code
25 //! #include <Standard_WarningsDisable.hxx>
26 //! #include <dirty_header.h> // some header that can generate warnings
27 //! #include <Standard_WarningsRestore.hxx>
28 //! @endcode
29
30 #if defined(__clang__)
31   #pragma clang diagnostic pop
32 #elif defined(_MSC_VER)
33   #pragma warning(pop)
34 #elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
35   #pragma GCC diagnostic pop
36 #endif
37