From bcf4e56fe02042af1accd01b207870a55e1c65b4 Mon Sep 17 00:00:00 2001
From: Aris Adamantiadis <aris@0xbadc0de.be>
Date: Fri, 27 Aug 2010 12:01:42 +0200
Subject: [PATCH] Fix C++ documentation about the exceptions

---
 include/libssh/libsshpp.hpp | 7 +++++++
 1 file changed, 7 insertions(+)

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.
  * @{
  */