diff options
author | Dave Davenport <qball@gmpclient.org> | 2016-01-05 19:49:13 +0100 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2016-01-05 19:49:13 +0100 |
commit | 329f31bd75425e62378d2a247b21847122372023 (patch) | |
tree | bbf7b61f7068235dd0b7cc411a8d19b6cb4d5828 /include | |
parent | 4fbf24948069f5432696a390b580ba8758789dc1 (diff) |
Add doxygen target.
Diffstat (limited to 'include')
-rw-r--r-- | include/dialogs/ssh.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/include/dialogs/ssh.h b/include/dialogs/ssh.h index c5ff29dc..7956528a 100644 --- a/include/dialogs/ssh.h +++ b/include/dialogs/ssh.h @@ -1,5 +1,24 @@ #ifndef __SSH_DIALOG_H__ #define __SSH_DIALOG_H__ +/** + * @defgroup SSHMode SSH + * + * SSH Mode, returns a list of known SSH hosts the user can log into. + * It does this by parsing the SSH config file and optional the known host and host list + * It also keeps history of the last choosen hosts. + * + * This mode uses the following options from the #config object: + * * #_Settings::ssh_command + * * #_Settings::parse_known_hosts + * * #_Settings::parse_hosts + * + * @{ + */ + +/** + * SSH Mode object. + */ extern Mode ssh_mode; +/*@}*/ #endif |