1
0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-27 13:21:11 +03:00

Improve documentation by mentioning the free functions

Related: https://gitlab.com/libssh/libssh-mirror/-/issues/3
Signed-off-by: Jakub Jelen <jjelen@redhat.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Jakub Jelen
2022-05-24 09:41:31 +02:00
committed by Andreas Schneider
parent 6623856e08
commit 1d238694e7
7 changed files with 54 additions and 27 deletions

View File

@@ -57,11 +57,12 @@
* @param src The session to use to copy the options.
*
* @param dest A pointer to store the allocated session with duplicated
* options. You have to free the memory.
* options. You have to free the memory using ssh_free()
*
* @returns 0 on success, -1 on error with errno set.
*
* @see ssh_session_connect()
* @see ssh_free()
*/
int ssh_options_copy(ssh_session src, ssh_session *dest)
{