Skip to content

Commit

Permalink
Improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jjnicola committed Sep 1, 2021
1 parent 407179d commit 5b2da01
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions nasl/nasl_ssh.c
Original file line number Diff line number Diff line change
Expand Up @@ -1903,15 +1903,16 @@ nasl_ssh_shell_close (lex_ctxt *lexic)
*/

/**
* @brief Check if SFTP is enabled.
* @brief Check if the SFTP subsystem is enabled on the remote SSH server.
* @naslfn{sftp_enabled_check}
*
* @nasluparam
*
* - An SSH session id.
*
* @naslret An integer: 0 on success, -1 (SSH_ERROR) on Channel request
* subsystem failure. Greather than 0 means an error during SFTP init.
* subsystem failure. Greater than 0 means an error during SFTP init. NULL
* indicates a failure during session id verification.
*
* @param[in] lexic Lexical context of NASL interpreter.
*/
Expand Down

0 comments on commit 5b2da01

Please sign in to comment.