diff options
| -rw-r--r-- | doc/mainpage.dox | 8 | ||||
| -rw-r--r-- | include/libssh/libsshpp.hpp | 5 |
2 files changed, 6 insertions, 7 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 95f6529..53168ec 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -1,12 +1,8 @@ /** * @mainpage * This manual documents the libssh C API. + * You should start by reading @subpage tutorial, then reading the documentation of + * the interesting functions as you go. * - * There are several other places to look for libssh information, such as the - * <a href="http://dev.libssh.org/wiki/Tutorial" target="_blank">tutorial</a> - * and the specification; those can be found at the <a - * href="http://www.libssh.org/" target="_blank">libssh website</a>. - * - * To be continued... */ diff --git a/include/libssh/libsshpp.hpp b/include/libssh/libsshpp.hpp index 1a4644a..5250057 100644 --- a/include/libssh/libsshpp.hpp +++ b/include/libssh/libsshpp.hpp @@ -36,6 +36,9 @@ * linking mode, which the compiler can decide to do in some case. There would be nearly no * performance penalty of using the wrapper rather than native calls. * + * Please visit the documentation of ssh::Session and ssh::Channel + * @see ssh::Session + * @see ssh::Channel * @{ */ @@ -407,5 +410,5 @@ private: } // namespace ssh -/* @} */ +/** @} */ #endif /* LIBSSHPP_HPP_ */ |