Page MenuHomePhabricator

Document more @return values with doxygen for APIs
Needs ReviewPublic

Authored by ngie-eign on Fri, Mar 29, 6:39 PM.

Details

Reviewers
asn
Group Reviewers
Restricted Project
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>

Test Plan

n/a

Diff Detail

Repository
rLIBSSH libssh
Branch
channel-document-return-codes
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 26
Build 26: arc lint + arc unit

Event Timeline

ngie-eign created this revision.Fri, Mar 29, 6:39 PM
ngie-eign retitled this revision from Document more @return values with doxygen for external APIs to Document more @return values with doxygen for APIs.Fri, Mar 29, 6:42 PM
ngie-eign edited the summary of this revision. (Show Details)