1
1

Fix a few documentation issues

Этот коммит содержится в:
Aris Adamantiadis 2010-08-28 21:05:24 +02:00
родитель a9fafc32a8
Коммит 29a229724b
3 изменённых файлов: 13 добавлений и 13 удалений

Просмотреть файл

@ -369,7 +369,7 @@ public:
Channel *newchan = new Channel(getSession(),x11chan); Channel *newchan = new Channel(getSession(),x11chan);
return newchan; return newchan;
} }
/** @change the size of a pseudoterminal /** @brief change the size of a pseudoterminal
* @param[in] cols number of columns * @param[in] cols number of columns
* @param[in] rows number of rows * @param[in] rows number of rows
* @throws SshException on error * @throws SshException on error

Просмотреть файл

@ -646,21 +646,18 @@ static int privatekey_type_from_file(FILE *fp) {
/** /**
* @brief Reads a SSH private key from a file. * @brief Reads a SSH private key from a file.
* *
* @param[in] session The SSH Session to use. * @param[in] session The SSH Session to use.
* *
* @param[in] filename The filename of the the private key. * @param[in] filename The filename of the the private key.
* *
* @param[in] type The type of the private key. This could be SSH_KEYTYPE_DSS or * @param[in] type The type of the private key. This could be SSH_KEYTYPE_DSS or
* SSH_KEYTYPE_RSA. Pass 0 to automatically detect the type. * SSH_KEYTYPE_RSA. Pass 0 to automatically detect the type.
* *
* @param[in] passphrase The passphrase to decrypt the private key. Set to null * @param[in] passphrase The passphrase to decrypt the private key. Set to null
* if none is needed or it is unknown. * if none is needed or it is unknown.
*
* @returns A private_key object containing the private key, or
* NULL on error.
*
* @todo Implement to read both DSA and RSA at once.
* *
* @return A private_key object containing the private key, or
* NULL on error.
* @see privatekey_free() * @see privatekey_free()
* @see publickey_from_privatekey() * @see publickey_from_privatekey()
*/ */
@ -679,6 +676,8 @@ ssh_private_key privatekey_from_file(ssh_session session, const char *filename,
DSA *dsa = NULL; DSA *dsa = NULL;
RSA *rsa = NULL; RSA *rsa = NULL;
#endif #endif
/* TODO Implement to read both DSA and RSA at once. */
/* needed for openssl initialization */ /* needed for openssl initialization */
ssh_init(); ssh_init();
ssh_log(session, SSH_LOG_RARE, "Trying to open %s", filename); ssh_log(session, SSH_LOG_RARE, "Trying to open %s", filename);

Просмотреть файл

@ -1126,10 +1126,11 @@ char *ssh_message_channel_request_subsystem(ssh_message msg){
/** @brief defines the SSH_MESSAGE callback /** @brief defines the SSH_MESSAGE callback
* @param session the current ssh session * @param session the current ssh session
* @param ssh_message_callback_ a function pointer to a callback taking the * @param[in] ssh_message_callback_ a function pointer to a callback taking the
* current ssh session and received message as parameters. the function returns * current ssh session and received message as parameters. the function returns
* 0 if the message has been parsed and treated sucessfuly, 1 otherwise (libssh * 0 if the message has been parsed and treated sucessfuly, 1 otherwise (libssh
* must take care of the response). * must take care of the response).
* @param[in] data void pointer to be passed to callback functions
*/ */
void ssh_set_message_callback(ssh_session session, void ssh_set_message_callback(ssh_session session,
int(*ssh_message_callback_)(ssh_session session, ssh_message msg, void *data), void *data){ int(*ssh_message_callback_)(ssh_session session, ssh_message msg, void *data), void *data){