shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-11 10:40:27 +09:00
Code Issues Packages Projects Releases Wiki Activity

Fixed doxygen compilation warnings

Browse Source
This commit is contained in:
Aris Adamantiadis
2009-09-26 01:34:14 +02:00
parent 3e314e863c
commit 0f77578ee2
7 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/libssh/sftp.h
View File

@@ -418,7 +418,7 @@ LIBSSH_API int sftp_file_close(SFTP_FILE *file) SFTP_DEPRECATED;
* @return A sftp file handle, NULL on error with ssh and sftp * @return A sftp file handle, NULL on error with ssh and sftp
* error set. * error set.
*/ */
LIBSSH_API SFTP_FILE *sftp_open(SFTP_SESSION *session, const char *file, int flags, LIBSSH_API SFTP_FILE *sftp_open(SFTP_SESSION *session, const char *file, int access,
mode_t mode); mode_t mode);
LIBSSH_API void sftp_file_set_nonblocking(SFTP_FILE *handle); LIBSSH_API void sftp_file_set_nonblocking(SFTP_FILE *handle);

6
libssh/channels.c
View File

@@ -1229,13 +1229,13 @@ int channel_request_shell(ssh_channel channel) {
* *
* @param channel The channel to send the request. * @param channel The channel to send the request.
* *
* @param system The subsystem to request (for example "sftp"). * @param subsys The subsystem to request (for example "sftp").
* *
* @return SSH_SUCCESS on success, SSH_ERROR on error. * @return SSH_SUCCESS on success, SSH_ERROR on error.
* *
* @warning You normally don't have to call it for sftp, see sftp_new(). * @warning You normally don't have to call it for sftp, see sftp_new().
*/ */
int channel_request_subsystem(ssh_channel channel, const char *sys) { int channel_request_subsystem(ssh_channel channel, const char *subsys) {
ssh_buffer buffer = NULL; ssh_buffer buffer = NULL;
ssh_string subsystem = NULL; ssh_string subsystem = NULL;
int rc = SSH_ERROR; int rc = SSH_ERROR;
@@ -1245,7 +1245,7 @@ int channel_request_subsystem(ssh_channel channel, const char *sys) {
goto error; goto error;
} }
subsystem = string_from_char(sys); subsystem = string_from_char(subsys);
if (subsystem == NULL) { if (subsystem == NULL) {
goto error; goto error;
} }

2
libssh/dh.c
View File

@@ -856,8 +856,6 @@ int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash) {
return MD5_DIGEST_LEN; return MD5_DIGEST_LEN;
} }
/** \addtogroup ssh_session
* @{ */
/** /**
* @brief Deallocate the hash obtained by ssh_get_pubkey_hash. * @brief Deallocate the hash obtained by ssh_get_pubkey_hash.
* This is required under Microsoft platform as this library might use a * This is required under Microsoft platform as this library might use a

6
libssh/error.c
View File

@@ -76,13 +76,13 @@ const char *ssh_get_error(void *error) {
* *
* @param error The SSH session pointer. * @param error The SSH session pointer.
* *
* \return SSH_NO_ERROR No error occured\n * \return SSH_NO_ERROR No error occurred\n
* SSH_REQUEST_DENIED The last request was denied but situation is * SSH_REQUEST_DENIED The last request was denied but situation is
* recoverable\n * recoverable\n
* SSH_FATAL A fatal error occured. This could be an unexpected * SSH_FATAL A fatal error occurred. This could be an unexpected
* disconnection\n * disconnection\n
* *
* \nOther error codes are internal but can be considered same than * Other error codes are internal but can be considered same than
* SSH_FATAL. * SSH_FATAL.
*/ */
int ssh_get_error_code(void *error) { int ssh_get_error_code(void *error) {

2
libssh/keyfiles.c
View File

@@ -865,7 +865,7 @@ void privatekey_free(ssh_private_key prv) {
/** \brief Retrieve a public key from a file /** \brief Retrieve a public key from a file
* \param session the SSH session * \param session the SSH session
* \param filename Filename of the key * \param filename Filename of the key
* \param _type Pointer to a integer. If it is not null, it contains the type of the key after execution. * \param type Pointer to a integer. If it is not null, it contains the type of the key after execution.
* \return a SSH String containing the public key, or NULL if it failed. * \return a SSH String containing the public key, or NULL if it failed.
* \see string_free() * \see string_free()
* \see publickey_from_privatekey() * \see publickey_from_privatekey()

4
libssh/options.c
View File

@@ -997,7 +997,9 @@ int ssh_options_allow_ssh2(ssh_options opt, int allow) {
* *
* @param opt The options structure to use. * @param opt The options structure to use.
* *
* @param callback A callback function for the printing. * @param cb A callback function for the printing.
*
* @param userdata Pointer to user-provided data
* *
* @return 0 on success, < 0 on error. * @return 0 on success, < 0 on error.
* *

4
libssh/string.c
View File

@@ -96,7 +96,7 @@ struct ssh_string_struct *string_from_char(const char *what) {
/** /**
* \brief returns the size of a SSH string * \brief returns the size of a SSH string
* \param str the input SSH string * \param s the input SSH string
* \return size of the content of str, 0 on error * \return size of the content of str, 0 on error
*/ */
size_t string_len(struct ssh_string_struct *s) { size_t string_len(struct ssh_string_struct *s) {
@@ -109,7 +109,7 @@ size_t string_len(struct ssh_string_struct *s) {
/** /**
* \brief convert a SSH string to a C nul-terminated string * \brief convert a SSH string to a C nul-terminated string
* \param str the input SSH string * \param s the input SSH string
* \return a malloc'ed string pointer. * \return a malloc'ed string pointer.
* \warning If the input SSH string contains zeroes, some parts of * \warning If the input SSH string contains zeroes, some parts of
* the output string may not be readable with regular libc functions. * the output string may not be readable with regular libc functions.