diff options
Diffstat (limited to 'src/userpref.h')
| -rw-r--r-- | src/userpref.h | 48 |
1 files changed, 21 insertions, 27 deletions
diff --git a/src/userpref.h b/src/userpref.h index 441c7be..c437e52 100644 --- a/src/userpref.h +++ b/src/userpref.h @@ -24,54 +24,48 @@ #include <gnutls/gnutls.h> /** -* \fn char* get_host_id() -* method to get user's HostID. Caller must free returned buffer. -* \return the HostID if exist in config file. Returns NULL otherwise. -*/ + * Method to get user's HostID. Caller must free returned buffer. + * + * @return the HostID if exist in config file. Returns NULL otherwise. + */ char* get_host_id(); /** -* \fn int is_device_known(char* public_key) -* determine if we already paired this device. -* \return 1 if device is already paired. Returns 0 otherwise. -*/ + * Determine if we already paired this device. + * + * @return 1 if device is already paired. Returns 0 otherwise. + */ int is_device_known(char* public_key); /** -* \fn int store_device_public_key(char* public_key) -* \return 1 if everything went well. Returns 0 otherwise. -*/ + * @return 1 if everything went well. Returns 0 otherwise. + */ int store_device_public_key(char* public_key); /** -* \fn int get_root_private_key(gnutls_datum_t* root_privkey) -* \return 1 if everything went well. Returns 0 otherwise. -*/ + * @return 1 if everything went well. Returns 0 otherwise. + */ int get_root_private_key(gnutls_datum_t* root_privkey); /** -* \fn int get_host_private_key(gnutls_datum_t* host_privkey) -* \return 1 if everything went well. Returns 0 otherwise. -*/ + * @return 1 if everything went well. Returns 0 otherwise. + */ int get_host_private_key(gnutls_datum_t* host_privkey); /** -* \fn int get_root_certificate(gnutls_datum_t* root_cert) -* \return 1 if everything went well. Returns 0 otherwise. -*/ + * @return 1 if everything went well. Returns 0 otherwise. + */ int get_root_certificate(gnutls_datum_t* root_cert); /** -* \fn int get_host_certificate(gnutls_datum_t* host_cert) -* \return 1 if everything went well. Returns 0 otherwise. -*/ + * @return 1 if everything went well. Returns 0 otherwise. + */ int get_host_certificate(gnutls_datum_t* host_cert); /** -* \fn int init_config_file(char* host_id, gnutls_datum_t* root_key, gnutls_datum_t* host_key, gnutls_datum_t* root_cert, gnutls_datum_t* host_cert) -* setup a brand new config file. -* \return 1 if everything went well. Returns 0 otherwise. -*/ + * Setup a brand new config file. + * @return 1 if everything went well. Returns 0 otherwise. + */ int init_config_file(char* host_id, gnutls_datum_t* root_key, gnutls_datum_t* host_key, gnutls_datum_t* root_cert, gnutls_datum_t* host_cert); #endif |