summaryrefslogtreecommitdiffstats
path: root/src/userpref.h
diff options
context:
space:
mode:
authorGravatar Matt Colyer2008-08-06 00:10:25 -0700
committerGravatar Matt Colyer2008-08-06 00:10:25 -0700
commitd81a3c5c412cca9b8327d6d27625bc52650e9651 (patch)
tree23986c22a08126efcf29c0ad637424a8858c2e00 /src/userpref.h
parent2dcc296d9209b02d3e794f953fcf995a4a19a498 (diff)
downloadlibimobiledevice-d81a3c5c412cca9b8327d6d27625bc52650e9651.tar.gz
libimobiledevice-d81a3c5c412cca9b8327d6d27625bc52650e9651.tar.bz2
Finish converting over to doxygen.
(I thought there was more documentation there but apparently we need to add some)
Diffstat (limited to 'src/userpref.h')
-rw-r--r--src/userpref.h48
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 @@
24 24
25#include <gnutls/gnutls.h> 25#include <gnutls/gnutls.h>
26/** 26/**
27* \fn char* get_host_id() 27 * Method to get user's HostID. Caller must free returned buffer.
28* method to get user's HostID. Caller must free returned buffer. 28 *
29* \return the HostID if exist in config file. Returns NULL otherwise. 29 * @return the HostID if exist in config file. Returns NULL otherwise.
30*/ 30 */
31char* get_host_id(); 31char* get_host_id();
32 32
33/** 33/**
34* \fn int is_device_known(char* public_key) 34 * Determine if we already paired this device.
35* determine if we already paired this device. 35 *
36* \return 1 if device is already paired. Returns 0 otherwise. 36 * @return 1 if device is already paired. Returns 0 otherwise.
37*/ 37 */
38int is_device_known(char* public_key); 38int is_device_known(char* public_key);
39 39
40/** 40/**
41* \fn int store_device_public_key(char* public_key) 41 * @return 1 if everything went well. Returns 0 otherwise.
42* \return 1 if everything went well. Returns 0 otherwise. 42 */
43*/
44int store_device_public_key(char* public_key); 43int store_device_public_key(char* public_key);
45 44
46/** 45/**
47* \fn int get_root_private_key(gnutls_datum_t* root_privkey) 46 * @return 1 if everything went well. Returns 0 otherwise.
48* \return 1 if everything went well. Returns 0 otherwise. 47 */
49*/
50int get_root_private_key(gnutls_datum_t* root_privkey); 48int get_root_private_key(gnutls_datum_t* root_privkey);
51 49
52/** 50/**
53* \fn int get_host_private_key(gnutls_datum_t* host_privkey) 51 * @return 1 if everything went well. Returns 0 otherwise.
54* \return 1 if everything went well. Returns 0 otherwise. 52 */
55*/
56int get_host_private_key(gnutls_datum_t* host_privkey); 53int get_host_private_key(gnutls_datum_t* host_privkey);
57 54
58/** 55/**
59* \fn int get_root_certificate(gnutls_datum_t* root_cert) 56 * @return 1 if everything went well. Returns 0 otherwise.
60* \return 1 if everything went well. Returns 0 otherwise. 57 */
61*/
62int get_root_certificate(gnutls_datum_t* root_cert); 58int get_root_certificate(gnutls_datum_t* root_cert);
63 59
64/** 60/**
65* \fn int get_host_certificate(gnutls_datum_t* host_cert) 61 * @return 1 if everything went well. Returns 0 otherwise.
66* \return 1 if everything went well. Returns 0 otherwise. 62 */
67*/
68int get_host_certificate(gnutls_datum_t* host_cert); 63int get_host_certificate(gnutls_datum_t* host_cert);
69 64
70/** 65/**
71* \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) 66 * Setup a brand new config file.
72* setup a brand new config file. 67 * @return 1 if everything went well. Returns 0 otherwise.
73* \return 1 if everything went well. Returns 0 otherwise. 68 */
74*/
75int 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); 69int 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);
76#endif 70#endif
77 71