1
0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-29 01:03:57 +03:00

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
This commit is contained in:
Aris Adamantiadis
2008-05-12 21:51:13 +00:00
parent 6a80f1a049
commit 2cf6369113
8 changed files with 16 additions and 24 deletions

View File

@@ -13,7 +13,7 @@ samplessh_SOURCES = sample.c
samplesshd_SOURCES = samplesshd.c samplesshd_SOURCES = samplesshd.c
samplesftp: samplessh samplesftp: samplessh
$(LN_S) samplessh samplesftp $(LN_S) -f samplessh samplesftp
if HAS_DOXYGEN if HAS_DOXYGEN
install-doc: doxygen install-doc: doxygen

View File

@@ -25,8 +25,8 @@ MA 02111-1307, USA. */
#include <stdio.h> #include <stdio.h>
#include <string.h> #include <string.h>
/** defgroup ssh_auth /** \defgroup ssh_auth Authentication functions
* \brief functions to authenticate * \brief functions to authenticate to servers
*/ */
/** \addtogroup ssh_auth /** \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() * \param publickey a public key returned by publickey_from_file()
* \returns SSH_AUTH_ERROR : a serious error happened\n * \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_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() * SSH_AUTH_SUCCESS : The public key is accepted, you want now to use ssh_userauth_pubkey()
* \see publickey_from_file() * \see publickey_from_file()
* \see privatekey_from_file() * \see privatekey_from_file()

View File

@@ -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 This file is part of the SSH Library
@@ -24,7 +22,7 @@ MA 02111-1307, USA. */
#include <string.h> #include <string.h>
#include "libssh/priv.h" #include "libssh/priv.h"
/** defgroup ssh_buffer /** \defgroup ssh_buffer SSH Buffers
* \brief buffer handling * \brief buffer handling
*/ */

View File

@@ -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 This file is part of the SSH Library
@@ -31,7 +29,7 @@ MA 02111-1307, USA. */
#define WINDOWLIMIT 1024 #define WINDOWLIMIT 1024
#define WINDOWBASE 32000 #define WINDOWBASE 32000
/** defgroup ssh_channel /** \defgroup ssh_channel SSH Channels
* \brief functions that manage a channel * \brief functions that manage a channel
*/ */

View File

@@ -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 This file is part of the SSH Library
@@ -23,7 +21,7 @@ MA 02111-1307, USA. */
#include <stdio.h> #include <stdio.h>
#include <stdarg.h> #include <stdarg.h>
#include "libssh/priv.h" #include "libssh/priv.h"
/** defgroup ssh_error /** \defgroup ssh_error SSH Errors
* \brief error handling * \brief error handling
*/ */

View File

@@ -1,7 +1,7 @@
/* options.c */ /* options.c */
/* handle pre-connection options */ /* handle pre-connection options */
/* /*
Copyright 2003 Aris Adamantiadis Copyright 2003-2008 Aris Adamantiadis
This file is part of the SSH Library This file is part of the SSH Library
@@ -29,8 +29,8 @@ MA 02111-1307, USA. */
#include <sys/types.h> #include <sys/types.h>
#include "libssh/priv.h" #include "libssh/priv.h"
/** defgroup ssh_options /** \defgroup ssh_options SSH Options
* \brief options settings for a new ssh session * \brief options settings for a new SSH session
*/ */
/** \addtogroup ssh_options /** \addtogroup ssh_options
* @{ */ * @{ */

View File

@@ -1,7 +1,7 @@
/* session.c */ /* session.c */
/* contains the non-networking functions ssh_* */ /* contains the non-networking functions ssh_* */
/* /*
* Copyright 2005 Aris Adamantiadis * Copyright 2005-2008 Aris Adamantiadis
* *
* This file is part of the SSH Library * This file is part of the SSH Library
* *
@@ -20,7 +20,6 @@
* the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
* MA 02111-1307, USA. */ * MA 02111-1307, USA. */
/* ssh_new() returns a newly allocated SSH_SESSION structure pointer */
#include <string.h> #include <string.h>
#include <stdlib.h> #include <stdlib.h>
#include "libssh/libssh.h" #include "libssh/libssh.h"
@@ -28,7 +27,7 @@
#include "libssh/server.h" #include "libssh/server.h"
#define FIRST_CHANNEL 42 // why not ? it helps to find bugs. #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 * \brief functions that manage a session
*/ */
/** \addtogroup ssh_session /** \addtogroup ssh_session

View File

@@ -1,5 +1,3 @@
/*string.c */
/* string manipulations... */
/* /*
Copyright 2003-2008 Aris Adamantiadis Copyright 2003-2008 Aris Adamantiadis
@@ -24,7 +22,7 @@ MA 02111-1307, USA. */
#include <unistd.h> #include <unistd.h>
#include <string.h> #include <string.h>
#include "libssh/priv.h" #include "libssh/priv.h"
/** defgroup ssh_string /** \defgroup ssh_string SSH Strings
* \brief string manipulations * \brief string manipulations
*/ */
/** \addtogroup ssh_string /** \addtogroup ssh_string