HomePhabricator

Document more @return values with doxygen for APIs

Authored by ngie-eign on Mon, Apr 29, 9:59 AM.

Description

Document more @return values with doxygen for APIs

Summary:

  • Note that SSH_ERROR can be returned on error in ssh_channel_get_exit_status and ssh_channel_get_session.
  • Note the return codes for channel_open and grow_window; although these are internal APIs, it's best to document their behavior.
  • Replace @returns use with @return. While Doxygen supports the former as a synonym for @return, it isn't documented in the manual (and might not be supported by other downstream documentation tools).

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>

Test Plan: n/a

Reviewers: #libssh, asn

Differential Revision: https://bugs.libssh.org/D15

Details

Committed
asnMon, Apr 29, 1:17 PM
Differential Revision
Restricted Differential Revision
Parents
rLIBSSH815a53375e90: libcrypto: Fix compilation without deprecated OpenSSL APIs
Branches
Unknown
Tags
Unknown