lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-08-13 04:42:23 +03:00
Code Activity

Improve the documentation of ssh_options_getopt().

Browse Source 
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@373 7dcaeef0-15fb-0310-b436-a5af3365683c
This commit is contained in:
Andreas Schneider
2009-04-03 08:23:29 +00:00
parent 497c31d9a0
commit a4d98b58fc
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
libssh/options.c
View File

@@ -796,19 +796,25 @@ int ssh_options_set_log_verbosity(SSH_OPTIONS *opt, int verbosity) {
return 0; return 0;
} }
/** /**
* @brief Parse command line arguments.
*
* This is a helper for your application to generate the appropriate * This is a helper for your application to generate the appropriate
* options from the command line arguments.\n * options from the command line arguments.\n
* the argv array and argc value are changed so that parsed * The argv array and argc value are changed so that the parsed
* arguments won't appear anymore in them.\n * arguments wont appear anymore in them.\n
* The single arguments (without switches) are not parsed. thus, * The single arguments (without switches) are not parsed. thus,
* myssh -u aris localhost \n * myssh -l user localhost\n
* command won't set the hostname value of options to localhost. * The command wont set the hostname value of options to localhost.
* \brief parse command line arguments *
* \param options an empty option structure pointer * @param options An empty option structure pointer.
* \param argcptr pointer to argument count *
* \param argv arguments list pointer * @param argcptr The pointer to the argument count.
* \returns 0 on success, -1 on error *
* \sa ssh_options_new() * @param argv The arguments list pointer.
*
* @returns 0 on success, < 0 on error.
*
* @see ssh_options_new()
*/ */
int ssh_options_getopt(SSH_OPTIONS *options, int *argcptr, char **argv) { int ssh_options_getopt(SSH_OPTIONS *options, int *argcptr, char **argv) {
char *user = NULL; char *user = NULL;