aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <mail@cynapses.org>2009-12-18 23:11:25 +0100
committerAndreas Schneider <mail@cynapses.org>2009-12-18 23:12:47 +0100
commit0c992ece3b3d4a69d1238fba7d09f6d7ddb19f7e (patch)
tree0410d24f3796edc062f671f17c0b8f80c9429417 /include
parente124249a8b08ddc90763ad5290bb7ecca89d5ab6 (diff)
downloadlibssh-0c992ece3b3d4a69d1238fba7d09f6d7ddb19f7e.tar.gz
libssh-0c992ece3b3d4a69d1238fba7d09f6d7ddb19f7e.tar.xz
libssh-0c992ece3b3d4a69d1238fba7d09f6d7ddb19f7e.zip
Added a mainpage to doxygen.
Diffstat (limited to 'include')
-rw-r--r--include/libssh/priv.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/include/libssh/priv.h b/include/libssh/priv.h
index 1b751842..42d0daa7 100644
--- a/include/libssh/priv.h
+++ b/include/libssh/priv.h
@@ -30,6 +30,18 @@
#ifndef _LIBSSH_PRIV_H
#define _LIBSSH_PRIV_H
+/**
+ * @mainpage
+ * This manual documents the libssh C API.
+ *
+ * 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...
+ */
+
#include "config.h"
#ifdef _MSC_VER