diff options
| author | Aris Adamantiadis <aris@0xbadc0de.be> | 2010-08-27 12:01:42 +0200 |
|---|---|---|
| committer | Aris Adamantiadis <aris@0xbadc0de.be> | 2010-08-27 12:01:42 +0200 |
| commit | bcf4e56fe02042af1accd01b207870a55e1c65b4 (patch) | |
| tree | 60a0a85751521cb6c85fbe0569e26dc74475c5a0 /include/libssh | |
| parent | 1834ca38200a46e4d1f539f2ec7c1bcd93564b9a (diff) | |
| download | libssh-bcf4e56fe02042af1accd01b207870a55e1c65b4.tar.gz libssh-bcf4e56fe02042af1accd01b207870a55e1c65b4.tar.xz libssh-bcf4e56fe02042af1accd01b207870a55e1c65b4.zip | |
Fix C++ documentation about the exceptions
Diffstat (limited to 'include/libssh')
| -rw-r--r-- | include/libssh/libsshpp.hpp | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/include/libssh/libsshpp.hpp b/include/libssh/libsshpp.hpp index 99ceebd7..9bf3247e 100644 --- a/include/libssh/libsshpp.hpp +++ b/include/libssh/libsshpp.hpp @@ -39,6 +39,13 @@ * Please visit the documentation of ssh::Session and ssh::Channel * @see ssh::Session * @see ssh::Channel + * + * If you wish not to use C++ exceptions, please define SSH_NO_CPP_EXCEPTIONS: + * @code + * #define SSH_NO_CPP_EXCEPTIONS + * #include <libssh/libsshpp.hpp> + * @endcode + * All functions will then return SSH_ERROR in case of error. * @{ */ |