aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2008-05-12 21:51:13 +0000
committerAris Adamantiadis <aris@0xbadc0de.be>2008-05-12 21:51:13 +0000
commit2cf6369113a23bbd7fa0e6b872d4a7c1ab68272b (patch)
treeea89f8e4c75c89a098c8089a1c462a8b2950cf5a
parent6a80f1a049ae7a64fac5a0838c268eac3e6d0b8b (diff)
downloadlibssh-2cf6369113a23bbd7fa0e6b872d4a7c1ab68272b.tar.gz
libssh-2cf6369113a23bbd7fa0e6b872d4a7c1ab68272b.tar.xz
libssh-2cf6369113a23bbd7fa0e6b872d4a7c1ab68272b.zip
Doxygen changes
Modified the makefile so the ln -s never fails. git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@157 7dcaeef0-15fb-0310-b436-a5af3365683c
-rw-r--r--Makefile.am2
-rw-r--r--libssh/auth.c5
-rw-r--r--libssh/buffer.c6
-rw-r--r--libssh/channels.c6
-rw-r--r--libssh/error.c6
-rw-r--r--libssh/options.c6
-rw-r--r--libssh/session.c5
-rw-r--r--libssh/string.c4
8 files changed, 16 insertions, 24 deletions
diff --git a/Makefile.am b/Makefile.am
index 65c4640f..56004f73 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -13,7 +13,7 @@ samplessh_SOURCES = sample.c
samplesshd_SOURCES = samplesshd.c
samplesftp: samplessh
- $(LN_S) samplessh samplesftp
+ $(LN_S) -f samplessh samplesftp
if HAS_DOXYGEN
install-doc: doxygen
diff --git a/libssh/auth.c b/libssh/auth.c
index 0dba3da6..ff1e1ed3 100644
--- a/libssh/auth.c
+++ b/libssh/auth.c
@@ -25,8 +25,8 @@ MA 02111-1307, USA. */
#include <stdio.h>
#include <string.h>
-/** defgroup ssh_auth
- * \brief functions to authenticate
+/** \defgroup ssh_auth Authentication functions
+ * \brief functions to authenticate to servers
*/
/** \addtogroup ssh_auth
* @{ */
@@ -169,6 +169,7 @@ int ssh_userauth_none(SSH_SESSION *session,char *username){
* \param publickey a public key returned by publickey_from_file()
* \returns SSH_AUTH_ERROR : a serious error happened\n
* SSH_AUTH_DENIED : The server doesn't accept that public key as an authentication token. Try another key or another method\n
+ * SSH_AUTH_PARTIAL : You've been partially authenticated, you still have to use another method\n
* SSH_AUTH_SUCCESS : The public key is accepted, you want now to use ssh_userauth_pubkey()
* \see publickey_from_file()
* \see privatekey_from_file()
diff --git a/libssh/buffer.c b/libssh/buffer.c
index 8d63b4b2..04934f47 100644
--- a/libssh/buffer.c
+++ b/libssh/buffer.c
@@ -1,7 +1,5 @@
-/* buffer.c */
-/* Well, buffers */
/*
-Copyright 2003 Aris Adamantiadis
+Copyright 2003-2008 Aris Adamantiadis
This file is part of the SSH Library
@@ -24,7 +22,7 @@ MA 02111-1307, USA. */
#include <string.h>
#include "libssh/priv.h"
-/** defgroup ssh_buffer
+/** \defgroup ssh_buffer SSH Buffers
* \brief buffer handling
*/
diff --git a/libssh/channels.c b/libssh/channels.c
index 626b69c7..12fadbd0 100644
--- a/libssh/channels.c
+++ b/libssh/channels.c
@@ -1,7 +1,5 @@
-/* channels.c */
-/* It has support for ... ssh channels */
/*
-Copyright 2003 Aris Adamantiadis
+Copyright 2003-2008 Aris Adamantiadis
This file is part of the SSH Library
@@ -31,7 +29,7 @@ MA 02111-1307, USA. */
#define WINDOWLIMIT 1024
#define WINDOWBASE 32000
-/** defgroup ssh_channel
+/** \defgroup ssh_channel SSH Channels
* \brief functions that manage a channel
*/
diff --git a/libssh/error.c b/libssh/error.c
index 07169836..828a67ca 100644
--- a/libssh/error.c
+++ b/libssh/error.c
@@ -1,7 +1,5 @@
-/* error.c */
-/* it does contain error processing functions */
/*
-Copyright 2003,04 Aris Adamantiadis
+Copyright 2003-2008 Aris Adamantiadis
This file is part of the SSH Library
@@ -23,7 +21,7 @@ MA 02111-1307, USA. */
#include <stdio.h>
#include <stdarg.h>
#include "libssh/priv.h"
-/** defgroup ssh_error
+/** \defgroup ssh_error SSH Errors
* \brief error handling
*/
diff --git a/libssh/options.c b/libssh/options.c
index 04bcb553..cea7325e 100644
--- a/libssh/options.c
+++ b/libssh/options.c
@@ -1,7 +1,7 @@
/* options.c */
/* handle pre-connection options */
/*
-Copyright 2003 Aris Adamantiadis
+Copyright 2003-2008 Aris Adamantiadis
This file is part of the SSH Library
@@ -29,8 +29,8 @@ MA 02111-1307, USA. */
#include <sys/types.h>
#include "libssh/priv.h"
-/** defgroup ssh_options
- * \brief options settings for a new ssh session
+/** \defgroup ssh_options SSH Options
+ * \brief options settings for a new SSH session
*/
/** \addtogroup ssh_options
* @{ */
diff --git a/libssh/session.c b/libssh/session.c
index 973d4f8d..f4879f0c 100644
--- a/libssh/session.c
+++ b/libssh/session.c
@@ -1,7 +1,7 @@
/* session.c */
/* contains the non-networking functions ssh_* */
/*
- * Copyright 2005 Aris Adamantiadis
+ * Copyright 2005-2008 Aris Adamantiadis
*
* This file is part of the SSH Library
*
@@ -20,7 +20,6 @@
* the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
* MA 02111-1307, USA. */
-/* ssh_new() returns a newly allocated SSH_SESSION structure pointer */
#include <string.h>
#include <stdlib.h>
#include "libssh/libssh.h"
@@ -28,7 +27,7 @@
#include "libssh/server.h"
#define FIRST_CHANNEL 42 // why not ? it helps to find bugs.
-/** defgroup ssh_session
+/** \defgroup ssh_session SSH Session
* \brief functions that manage a session
*/
/** \addtogroup ssh_session
diff --git a/libssh/string.c b/libssh/string.c
index 151d8204..fc730a48 100644
--- a/libssh/string.c
+++ b/libssh/string.c
@@ -1,5 +1,3 @@
-/*string.c */
-/* string manipulations... */
/*
Copyright 2003-2008 Aris Adamantiadis
@@ -24,7 +22,7 @@ MA 02111-1307, USA. */
#include <unistd.h>
#include <string.h>
#include "libssh/priv.h"
-/** defgroup ssh_string
+/** \defgroup ssh_string SSH Strings
* \brief string manipulations
*/
/** \addtogroup ssh_string