diff options
| author | Aris Adamantiadis <aris@0xbadc0de.be> | 2006-11-06 22:58:58 +0000 |
|---|---|---|
| committer | Aris Adamantiadis <aris@0xbadc0de.be> | 2006-11-06 22:58:58 +0000 |
| commit | 44b54704433753599ff246e4461556afef645a5d (patch) | |
| tree | 33d96cd549c9a46a512097fc48d7c84a56816d1f /libssh/options.c | |
| parent | ea215fdecc62cc3ca25f707dade07941d66f7856 (diff) | |
| download | libssh-44b54704433753599ff246e4461556afef645a5d.tar.gz libssh-44b54704433753599ff246e4461556afef645a5d.tar.xz libssh-44b54704433753599ff246e4461556afef645a5d.zip | |
at least I get a working doxygen documentation.
I am going to make the whole documentation as doxygen files.
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@77 7dcaeef0-15fb-0310-b436-a5af3365683c
Diffstat (limited to 'libssh/options.c')
| -rw-r--r-- | libssh/options.c | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/libssh/options.c b/libssh/options.c index 813e3ad3..53a62854 100644 --- a/libssh/options.c +++ b/libssh/options.c @@ -27,7 +27,22 @@ MA 02111-1307, USA. */ #include <sys/types.h> #include "libssh/priv.h" -/* by default, ssh1 support is not allowed */ +/** defgroup ssh_options + * \brief options settings for a new ssh session + */ +/** \addtogroup ssh_options + * @{ */ + +/** This structure is freed automaticaly by ssh_disconnect() + * when you use it. \n + * It can be used by only one ssh_connect(), not more.\n + * also by default, ssh1 support is not allowed + * + * \brief initializes a new option structure + * \returns an empty intialized option structure. + * \see ssh_getopt() +*/ + SSH_OPTIONS *ssh_options_new(){ SSH_OPTIONS *option=malloc(sizeof(SSH_OPTIONS)); memset(option,0,sizeof(SSH_OPTIONS)); @@ -401,3 +416,7 @@ int ssh_options_getopt(SSH_OPTIONS *options, int *argcptr, char **argv){ } else return 0 ; } + + + +/** @} */ |