arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/354/merge
Jeffrey Walton 2017-03-10 03:14:43 -05:00
parent a0bb490056
commit 75a379593d
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ossig.h
View File

@ -46,6 +46,10 @@ extern "C" {
//! using sigaction flags set to 0. The default handler only returns from the call. //! using sigaction flags set to 0. The default handler only returns from the call.
//! \details Upon destruction the previous signal handler is restored if the former signal handler //! \details Upon destruction the previous signal handler is restored if the former signal handler
//! was replaced. //! was replaced.
//! \details On Cygwin systems using Newlib, you need to ensure you define <tt>_XOPEN_SOURCE=700</tt>,
//! <tt>_GNU_SOURCE</tt>; or use <tt>-std=gnu++03</tt>, <tt>-std=gnu++11</tt>, or similar. If
//! you compile with <tt>-std=c++03</tt>, <tt>-std=c++11</tt> or similar, then define
//! <tt>_XOPEN_SOURCE=700</tt>.
//! \warning Do not use SignalHandler in a code block that uses <tt>setjmp</tt> or <tt>longjmp</tt> //! \warning Do not use SignalHandler in a code block that uses <tt>setjmp</tt> or <tt>longjmp</tt>
//! because the destructor may not run. //! because the destructor may not run.
//! \since Crypto++ 5.6.5 //! \since Crypto++ 5.6.5
@ -63,6 +67,10 @@ struct SignalHandler
//! using sigaction flags set to 0. The default handler only returns from the call. //! using sigaction flags set to 0. The default handler only returns from the call.
//! \details Upon destruction the previous signal handler is restored if the former signal handler //! \details Upon destruction the previous signal handler is restored if the former signal handler
//! was overwritten. //! was overwritten.
//! \details On Cygwin systems using Newlib, you need to ensure you define <tt>_XOPEN_SOURCE=700</tt>,
//! <tt>_GNU_SOURCE</tt>; or use <tt>-std=gnu++03</tt>, <tt>-std=gnu++11</tt>, or similar. If
//! you compile with <tt>-std=c++03</tt>, <tt>-std=c++11</tt> or similar, then define
//! <tt>_XOPEN_SOURCE=700</tt>.
//! \warning Do not use SignalHandler in a code block that uses <tt>setjmp</tt> or <tt>longjmp</tt> //! \warning Do not use SignalHandler in a code block that uses <tt>setjmp</tt> or <tt>longjmp</tt>
//! because the destructor may not run. <tt>setjmp</tt> is why cpu.cpp does not use SignalHandler //! because the destructor may not run. <tt>setjmp</tt> is why cpu.cpp does not use SignalHandler
//! during CPU feature testing. //! during CPU feature testing.