summaryrefslogtreecommitdiffstats
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:11:25 +0100
commite539eaf9e05cf22bf6d75724beb3e6e3c7e5290a (patch)
treedaf1f42ff9dd6cb10c7547e446e919c4577be667
parentb728f44ce97fd985582f99d443125f40e399ae4f (diff)
Added a mainpage to doxygen.
-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 b651a792..66352a70 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