diff options
author | Simon Josefsson <simon@josefsson.org> | 2004-10-28 12:09:49 +0000 |
---|---|---|
committer | Simon Josefsson <simon@josefsson.org> | 2004-10-28 12:09:49 +0000 |
commit | c9ac4210a147bb0b7f8e74716aa471f4debb2698 (patch) | |
tree | 7c4b5bc3f458816caea9f0ec8761c4642409c8dc | |
parent | 93d092491fed3795af5218dfaad00e67fa91d2ff (diff) | |
download | gnutls-c9ac4210a147bb0b7f8e74716aa471f4debb2698.tar.gz |
Doc fix.
-rw-r--r-- | lib/ext_server_name.c | 4 | ||||
-rw-r--r-- | lib/gnutls_alert.c | 8 | ||||
-rw-r--r-- | lib/gnutls_anon_cred.c | 10 | ||||
-rw-r--r-- | lib/gnutls_auth.c | 14 | ||||
-rw-r--r-- | lib/gnutls_buffers.c | 2 | ||||
-rw-r--r-- | lib/gnutls_cert.c | 20 | ||||
-rw-r--r-- | lib/gnutls_db.c | 16 | ||||
-rw-r--r-- | lib/gnutls_handshake.c | 10 | ||||
-rw-r--r-- | lib/gnutls_priority.c | 16 | ||||
-rw-r--r-- | lib/gnutls_record.c | 22 | ||||
-rw-r--r-- | lib/gnutls_session.c | 6 | ||||
-rw-r--r-- | lib/gnutls_srp.c | 16 | ||||
-rw-r--r-- | lib/gnutls_state.c | 38 | ||||
-rw-r--r-- | lib/gnutls_ui.c | 2 | ||||
-rw-r--r-- | lib/gnutls_x509.c | 20 | ||||
-rw-r--r-- | lib/minitasn1/structure.c | 2 | ||||
-rw-r--r-- | libextra/gnutls_openpgp.c | 2 |
17 files changed, 104 insertions, 104 deletions
diff --git a/lib/ext_server_name.c b/lib/ext_server_name.c index 625bcab80b..98e275a482 100644 --- a/lib/ext_server_name.c +++ b/lib/ext_server_name.c @@ -198,7 +198,7 @@ int _gnutls_server_name_send_params(gnutls_session_t session, /** * gnutls_server_name_get - Used to get the server name indicator send by a client - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @data: will hold the data * @data_length: will hold the data length. Must hold the maximum size of data. * @type: will hold the server name indicator type @@ -263,7 +263,7 @@ int gnutls_server_name_get(gnutls_session_t session, void *data, /** * gnutls_server_name_set - Used to set a name indicator to be sent as an extension - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @type: specifies the indicator type * @name: is a string that contains the server name. * @name_length: holds the length of name diff --git a/lib/gnutls_alert.c b/lib/gnutls_alert.c index 5accdd7b8d..521e2ce9a0 100644 --- a/lib/gnutls_alert.c +++ b/lib/gnutls_alert.c @@ -75,7 +75,7 @@ static const gnutls_alert_entry sup_alerts[] = { /** * gnutls_alert_get_name - Returns a string describing the alert number given - * @alert: is an alert number &gnutls_session_t structure. + * @alert: is an alert number #gnutls_session_t structure. * * Returns a string that describes the given alert number or NULL. * See gnutls_alert_get(). @@ -92,7 +92,7 @@ const char *gnutls_alert_get_name(gnutls_alert_level_t alert) /** * gnutls_alert_send - This function sends an alert message to the peer - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @level: is the level of the alert * @desc: is the alert description * @@ -241,7 +241,7 @@ int gnutls_error_to_alert(int err, int *level) /** * gnutls_alert_send_appropriate - This function sends an alert to the peer depending on the error code - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @err: is an integer * * This function is DEPRECATED, and may be removed. @@ -270,7 +270,7 @@ int gnutls_alert_send_appropriate(gnutls_session_t session, int err) /** * gnutls_alert_get - Returns the last alert number received. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the last alert number received. This function * should be called if GNUTLS_E_WARNING_ALERT_RECEIVED or diff --git a/lib/gnutls_anon_cred.c b/lib/gnutls_anon_cred.c index 299f72f005..1f4aca8b89 100644 --- a/lib/gnutls_anon_cred.c +++ b/lib/gnutls_anon_cred.c @@ -35,7 +35,7 @@ static const int anon_dummy; /** * gnutls_anon_free_server_credentials - Used to free an allocated gnutls_anon_server_credentials_t structure - * @sc: is an &gnutls_anon_server_credentials_t structure. + * @sc: is an #gnutls_anon_server_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to free (deallocate) it. @@ -49,7 +49,7 @@ void gnutls_anon_free_server_credentials(gnutls_anon_server_credentials_t /*- * _gnutls_anon_get_dh_params - Returns the DH parameters pointer - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will return the dh parameters pointer. * @@ -79,7 +79,7 @@ gnutls_dh_params_t _gnutls_anon_get_dh_params(const /** * gnutls_anon_allocate_server_credentials - Used to allocate an gnutls_anon_server_credentials_t structure - * @sc: is a pointer to an &gnutls_anon_server_credentials_t structure. + * @sc: is a pointer to an #gnutls_anon_server_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to allocate it. @@ -97,7 +97,7 @@ gnutls_anon_allocate_server_credentials(gnutls_anon_server_credentials_t * /** * gnutls_anon_free_client_credentials - Used to free an allocated gnutls_anon_client_credentials_t structure - * @sc: is an &gnutls_anon_client_credentials_t structure. + * @sc: is an #gnutls_anon_client_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to free (deallocate) it. @@ -109,7 +109,7 @@ void gnutls_anon_free_client_credentials(gnutls_anon_client_credentials_t /** * gnutls_anon_allocate_client_credentials - Used to allocate a credentials structure - * @sc: is a pointer to an &gnutls_anon_client_credentials_t structure. + * @sc: is a pointer to an #gnutls_anon_client_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to allocate it. diff --git a/lib/gnutls_auth.c b/lib/gnutls_auth.c index e5f4322414..863f4b08e7 100644 --- a/lib/gnutls_auth.c +++ b/lib/gnutls_auth.c @@ -36,7 +36,7 @@ /** * gnutls_credentials_clear - Clears all the credentials previously set - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Clears all the credentials previously set in this session. * @@ -61,7 +61,7 @@ void gnutls_credentials_clear(gnutls_session_t session) */ /** * gnutls_credentials_set - Sets the needed credentials for the specified authentication algorithm. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @type: is the type of the credentials * @cred: is a pointer to a structure. * @@ -137,7 +137,7 @@ int gnutls_credentials_set(gnutls_session_t session, /** * gnutls_auth_get_type - Returns the type of credentials for the current authentication schema. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns type of credentials for the current authentication schema. * The returned information is to be used to distinguish the function used @@ -162,7 +162,7 @@ gnutls_credentials_type_t gnutls_auth_get_type(gnutls_session_t session) /** * gnutls_auth_server_get_type - Returns the type of credentials for the server authentication schema. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the type of credentials that were used for server authentication. * The returned information is to be used to distinguish the function used @@ -180,7 +180,7 @@ gnutls_credentials_type_t gnutls_auth_server_get_type(gnutls_session_t /** * gnutls_auth_client_get_type - Returns the type of credentials for the client authentication schema. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the type of credentials that were used for client authentication. * The returned information is to be used to distinguish the function used @@ -242,7 +242,7 @@ const void *_gnutls_get_cred(gnutls_key_st key, /*- * _gnutls_get_auth_info - Returns a pointer to authentication information. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function must be called after a succesful gnutls_handshake(). * Returns a pointer to authentication information. That information @@ -260,7 +260,7 @@ void *_gnutls_get_auth_info(gnutls_session_t session) /*- * _gnutls_free_auth_info - Frees the auth info structure - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function frees the auth info structure and sets it to * null. It must be called since some structures contain malloced diff --git a/lib/gnutls_buffers.c b/lib/gnutls_buffers.c index 292aa71c0e..22587ddd4e 100644 --- a/lib/gnutls_buffers.c +++ b/lib/gnutls_buffers.c @@ -135,7 +135,7 @@ int _gnutls_record_buffer_get_size(content_type_t type, /** * gnutls_record_check_pending - checks if there are any data to receive in gnutls buffers. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function checks if there are any data to receive * in the gnutls buffers. Returns the size of that data or 0. diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c index 7770f12cd3..d2dedf50a3 100644 --- a/lib/gnutls_cert.c +++ b/lib/gnutls_cert.c @@ -47,7 +47,7 @@ void gnutls_certificate_free_crls(gnutls_certificate_credentials_t sc); /** * gnutls_certificate_free_keys - Used to free all the keys from a gnutls_certificate_credentials_t structure - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will delete all the keys and the certificates associated * with the given credentials. This function must not be called when a @@ -84,7 +84,7 @@ void gnutls_certificate_free_keys(gnutls_certificate_credentials_t sc) /** * gnutls_certificate_free_cas - Used to free all the CAs from a gnutls_certificate_credentials_t structure - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will delete all the CAs associated * with the given credentials. Servers that do not use @@ -109,7 +109,7 @@ void gnutls_certificate_free_cas(gnutls_certificate_credentials_t sc) /** * gnutls_certificate_free_ca_names - Used to free all the CA names from a gnutls_certificate_credentials_t structure - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will delete all the CA name in the * given credentials. Clients may call this to save some memory @@ -126,7 +126,7 @@ void gnutls_certificate_free_ca_names(gnutls_certificate_credentials_t sc) /*- * _gnutls_certificate_get_dh_params - Returns the DH parameters pointer - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will return the dh parameters pointer. This will read the * credentials structure, and cache the output to the session, so later @@ -161,7 +161,7 @@ gnutls_dh_params_t _gnutls_certificate_get_dh_params(const /*- * _gnutls_certificate_get_rsa_params - Returns the RSA parameters pointer - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will return the rsa parameters pointer. * @@ -196,7 +196,7 @@ gnutls_rsa_params_t _gnutls_certificate_get_rsa_params(const /** * gnutls_certificate_free_credentials - Used to free an allocated gnutls_certificate_credentials_t structure - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to free (deallocate) it. @@ -223,7 +223,7 @@ void gnutls_certificate_free_credentials(gnutls_certificate_credentials_t /** * gnutls_certificate_allocate_credentials - Used to allocate a gnutls_certificate_credentials_t structure - * @res: is a pointer to an &gnutls_certificate_credentials_t structure. + * @res: is a pointer to an #gnutls_certificate_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to allocate it. @@ -301,7 +301,7 @@ int _gnutls_selected_cert_supported_kx(gnutls_session_t session, /** * gnutls_certificate_server_set_request - Used to set whether to request a client certificate - * @session: is an &gnutls_session_t structure. + * @session: is an #gnutls_session_t structure. * @req: is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE * * This function specifies if we (in case of a server) are going @@ -320,7 +320,7 @@ void gnutls_certificate_server_set_request(gnutls_session_t session, /** * gnutls_certificate_client_set_retrieve_function - Used to set a callback to retrieve the certificate - * @cred: is a &gnutls_certificate_credentials_t structure. + * @cred: is a #gnutls_certificate_credentials_t structure. * @func: is the callback function * * This function sets a callback to be called in order to retrieve the certificate @@ -356,7 +356,7 @@ void gnutls_certificate_client_set_retrieve_function /** * gnutls_certificate_server_set_retrieve_function - Used to set a callback to retrieve the certificate - * @cred: is a &gnutls_certificate_credentials_t structure. + * @cred: is a #gnutls_certificate_credentials_t structure. * @func: is the callback function * * This function sets a callback to be called in order to retrieve the certificate diff --git a/lib/gnutls_db.c b/lib/gnutls_db.c index 9f7efc22d7..06c2234c3a 100644 --- a/lib/gnutls_db.c +++ b/lib/gnutls_db.c @@ -33,7 +33,7 @@ /** * gnutls_db_set_retrieve_function - Sets the function that will be used to get data - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @retr_func: is the function. * * Sets the function that will be used to retrieve data from the resumed @@ -55,7 +55,7 @@ void gnutls_db_set_retrieve_function(gnutls_session_t session, /** * gnutls_db_set_remove_function - Sets the function that will be used to remove data - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @rem_func: is the function. * * Sets the function that will be used to remove data from the resumed @@ -73,7 +73,7 @@ void gnutls_db_set_remove_function(gnutls_session_t session, /** * gnutls_db_set_store_function - Sets the function that will be used to put data - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @store_func: is the function * * Sets the function that will be used to store data from the resumed @@ -91,7 +91,7 @@ void gnutls_db_set_store_function(gnutls_session_t session, /** * gnutls_db_set_ptr - Sets a pointer to be sent to db functions - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @ptr: is the pointer * * Sets the pointer that will be provided to db store, retrieve and delete functions, as @@ -105,7 +105,7 @@ void gnutls_db_set_ptr(gnutls_session_t session, void *ptr) /** * gnutls_db_get_ptr - Returns the pointer which is sent to db functions - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the pointer that will be sent to db store, retrieve and delete functions, as * the first argument. @@ -118,7 +118,7 @@ void *gnutls_db_get_ptr(gnutls_session_t session) /** * gnutls_db_set_cache_expiration - Sets the expiration time for resumed sessions. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @seconds: is the number of seconds. * * Sets the expiration time for resumed sessions. The default is 3600 (one hour) @@ -131,7 +131,7 @@ void gnutls_db_set_cache_expiration(gnutls_session_t session, int seconds) /** * gnutls_db_check_entry - checks if the given db entry has expired - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @session_entry: is the session data (not key) * * This function returns GNUTLS_E_EXPIRED, if the database entry @@ -356,7 +356,7 @@ int _gnutls_remove_session(gnutls_session_t session, /** * gnutls_db_remove_session - This function will remove the current session data from the database - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function will remove the current session data from the session * database. This will prevent future handshakes reusing these session diff --git a/lib/gnutls_handshake.c b/lib/gnutls_handshake.c index 5a23130f2f..267c802148 100644 --- a/lib/gnutls_handshake.c +++ b/lib/gnutls_handshake.c @@ -1835,7 +1835,7 @@ int _gnutls_recv_hello(gnutls_session_t session, opaque * data, /** * gnutls_rehandshake - This function will renegotiate security parameters - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function will renegotiate security parameters with the * client. This should only be called in case of a server. @@ -1921,7 +1921,7 @@ inline static int _gnutls_handshake_hash_init(gnutls_session_t session) /** * gnutls_handshake - This is the main function in the handshake protocol. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function does the handshake of the TLS/SSL protocol, * and initializes the TLS connection. @@ -2569,7 +2569,7 @@ int _gnutls_remove_unwanted_ciphersuites(gnutls_session_t session, /** * gnutls_handshake_set_max_packet_length - This function will set the maximum length of a handshake message - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @max: is the maximum number. * * This function will set the maximum size of a handshake message. @@ -2599,7 +2599,7 @@ gnutls_protocol_t _gnutls_get_adv_version(gnutls_session_t session) /** * gnutls_handshake_get_last_in - Returns the last handshake message received. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the last handshake message received. This function is only useful * to check where the last performed handshake failed. If the previous handshake @@ -2615,7 +2615,7 @@ gnutls_handshake_get_last_in(gnutls_session_t session) /** * gnutls_handshake_get_last_out - Returns the last handshake message sent. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the last handshake message sent. This function is only useful * to check where the last performed handshake failed. If the previous handshake diff --git a/lib/gnutls_priority.c b/lib/gnutls_priority.c index 2dd3215873..db11a2956e 100644 --- a/lib/gnutls_priority.c +++ b/lib/gnutls_priority.c @@ -30,7 +30,7 @@ /** * gnutls_cipher_set_priority - Sets the priority on the ciphers supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @list: is a 0 terminated list of gnutls_cipher_algorithm_t elements. * * Sets the priority on the ciphers supported by gnutls. @@ -59,7 +59,7 @@ int gnutls_cipher_set_priority(gnutls_session_t session, const int *list) /** * gnutls_kx_set_priority - Sets the priority on the key exchange algorithms supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @list: is a 0 terminated list of gnutls_kx_algorithm_t elements. * * Sets the priority on the key exchange algorithms supported by gnutls. @@ -88,7 +88,7 @@ int gnutls_kx_set_priority(gnutls_session_t session, const int *list) /** * gnutls_mac_set_priority - Sets the priority on the mac algorithms supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @list: is a 0 terminated list of gnutls_mac_algorithm_t elements. * * Sets the priority on the mac algorithms supported by gnutls. @@ -117,7 +117,7 @@ int gnutls_mac_set_priority(gnutls_session_t session, const int *list) /** * gnutls_compression_set_priority - Sets the priority on the compression algorithms supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @list: is a 0 terminated list of gnutls_compression_method_t elements. * * Sets the priority on the compression algorithms supported by gnutls. @@ -152,7 +152,7 @@ int gnutls_compression_set_priority(gnutls_session_t session, /** * gnutls_protocol_set_priority - Sets the priority on the protocol versions supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @list: is a 0 terminated list of gnutls_protocol_t elements. * * Sets the priority on the protocol versions supported by gnutls. @@ -185,7 +185,7 @@ int gnutls_protocol_set_priority(gnutls_session_t session, const int *list) /** * gnutls_certificate_type_set_priority - Sets the priority on the certificate types supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @list: is a 0 terminated list of gnutls_certificate_type_t elements. * * Sets the priority on the certificate types supported by gnutls. @@ -223,7 +223,7 @@ int gnutls_certificate_type_set_priority(gnutls_session_t session, /** * gnutls_set_default_priority - Sets some default priority on the cipher suites supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Sets some default priority on the ciphers, key exchange methods, macs * and compression methods. This is to avoid using the gnutls_*_priority() functions, if @@ -261,7 +261,7 @@ int gnutls_set_default_priority(gnutls_session_t session) /** * gnutls_set_default_export_priority - Sets some default priority on the cipher suites supported by gnutls. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Sets some default priority on the ciphers, key exchange methods, macs * and compression methods. This is to avoid using the gnutls_*_priority() functions, if diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c index 91bbca79dd..e7c74a33a5 100644 --- a/lib/gnutls_record.c +++ b/lib/gnutls_record.c @@ -46,7 +46,7 @@ /** * gnutls_protocol_get_version - Returns the version of the currently used protocol - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the version of the currently used protocol. * @@ -64,7 +64,7 @@ void _gnutls_set_current_version(gnutls_session_t session, /** * gnutls_transport_set_lowat - Used to set the lowat value in order for select to check for pending data. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @num: is the low water value. * * Used to set the lowat value in order for select to check @@ -82,7 +82,7 @@ void gnutls_transport_set_lowat(gnutls_session_t session, int num) /** * gnutls_transport_set_ptr - Used to set first argument of the transport functions - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @ptr: is the value. * * Used to set the first argument of the transport function (like PUSH and @@ -100,7 +100,7 @@ void gnutls_transport_set_ptr(gnutls_session_t session, /** * gnutls_transport_set_ptr2 - Used to set first argument of the transport functions - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @recv_ptr: is the value for the pull function * @send_ptr: is the value for the push function * @@ -120,7 +120,7 @@ void gnutls_transport_set_ptr2(gnutls_session_t session, /** * gnutls_transport_get_ptr - Used to return the first argument of the transport functions - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Used to get the first argument of the transport function (like PUSH and * PULL). This must have been set using gnutls_transport_set_ptr(). @@ -133,7 +133,7 @@ gnutls_transport_ptr_t gnutls_transport_get_ptr(gnutls_session_t session) /** * gnutls_transport_get_ptr2 - Used to return the first argument of the transport functions - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @recv_ptr: will hold the value for the pull function * @send_ptr: will hold the value for the push function * @@ -152,7 +152,7 @@ void gnutls_transport_get_ptr2(gnutls_session_t session, /** * gnutls_bye - This function terminates the current TLS/SSL connection. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @how: is an integer * * Terminates the current TLS/SSL connection. The connection should @@ -972,7 +972,7 @@ ssize_t _gnutls_recv_int(gnutls_session_t session, content_type_t type, /** * gnutls_record_send - sends to the peer the specified data - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @data: contains the data to send * @sizeofdata: is the length of the data * @@ -1003,7 +1003,7 @@ ssize_t gnutls_record_send(gnutls_session_t session, const void *data, /** * gnutls_record_recv - reads data from the TLS record protocol - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @data: contains the data to send * @sizeofdata: is the length of the data * @@ -1032,7 +1032,7 @@ ssize_t gnutls_record_recv(gnutls_session_t session, void *data, /** * gnutls_record_get_max_size - returns the maximum record size - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function returns the maximum record packet size in this connection. * The maximum record size is negotiated by the client after the @@ -1050,7 +1050,7 @@ size_t gnutls_record_get_max_size(gnutls_session_t session) /** * gnutls_record_set_max_size - sets the maximum record size - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @size: is the new size * * This function sets the maximum record packet size in this connection. diff --git a/lib/gnutls_session.c b/lib/gnutls_session.c index 19af8cd482..ef3940c74b 100644 --- a/lib/gnutls_session.c +++ b/lib/gnutls_session.c @@ -28,7 +28,7 @@ /** * gnutls_session_get_data - Returns all session parameters. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @session_data: is a pointer to space to hold the session. * @session_data_size: is the session_data's size, or it will be set by the function. * @@ -73,7 +73,7 @@ int gnutls_session_get_data(gnutls_session_t session, /** * gnutls_session_get_id - Returns session id. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @session_id: is a pointer to space to hold the session id. * @session_id_size: is the session id's size, or it will be set by the function. * @@ -103,7 +103,7 @@ int gnutls_session_get_id(gnutls_session_t session, /** * gnutls_session_set_data - Sets all session parameters - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @session_data: is a pointer to space to hold the session. * @session_data_size: is the session's size * diff --git a/lib/gnutls_srp.c b/lib/gnutls_srp.c index df6bc9253c..bf8802a421 100644 --- a/lib/gnutls_srp.c +++ b/lib/gnutls_srp.c @@ -373,7 +373,7 @@ mpi_t _gnutls_calc_srp_S2(mpi_t B, mpi_t g, mpi_t x, /** * gnutls_srp_free_client_credentials - Used to free an allocated gnutls_srp_client_credentials_t structure - * @sc: is an &gnutls_srp_client_credentials_t structure. + * @sc: is an #gnutls_srp_client_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to free (deallocate) it. @@ -388,7 +388,7 @@ void gnutls_srp_free_client_credentials(gnutls_srp_client_credentials_t sc) /** * gnutls_srp_allocate_client_credentials - Used to allocate an gnutls_srp_server_credentials_t structure - * @sc: is a pointer to an &gnutls_srp_server_credentials_t structure. + * @sc: is a pointer to an #gnutls_srp_server_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to allocate it. @@ -408,7 +408,7 @@ int gnutls_srp_allocate_client_credentials(gnutls_srp_client_credentials_t /** * gnutls_srp_set_client_credentials - Used to set the username/password, in a gnutls_srp_client_credentials_t structure - * @res: is an &gnutls_srp_client_credentials_t structure. + * @res: is an #gnutls_srp_client_credentials_t structure. * @username: is the user's userid * @password: is the user's password * @@ -442,7 +442,7 @@ int gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t res, /** * gnutls_srp_free_server_credentials - Used to free an allocated gnutls_srp_server_credentials_t structure - * @sc: is an &gnutls_srp_server_credentials_t structure. + * @sc: is an #gnutls_srp_server_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to free (deallocate) it. @@ -458,7 +458,7 @@ void gnutls_srp_free_server_credentials(gnutls_srp_server_credentials_t sc) /** * gnutls_srp_allocate_server_credentials - Used to allocate an gnutls_srp_server_credentials_t structure - * @sc: is a pointer to an &gnutls_srp_server_credentials_t structure. + * @sc: is a pointer to an #gnutls_srp_server_credentials_t structure. * * This structure is complex enough to manipulate directly thus * this helper function is provided in order to allocate it. @@ -490,7 +490,7 @@ inline static int file_exists(const char *file) /** * gnutls_srp_set_server_credentials_file - Used to set the password files, in a gnutls_srp_server_credentials_t structure - * @res: is an &gnutls_srp_server_credentials_t structure. + * @res: is an #gnutls_srp_server_credentials_t structure. * @password_file: is the SRP password file (tpasswd) * @password_conf_file: is the SRP password conf file (tpasswd.conf) * @@ -541,7 +541,7 @@ int gnutls_srp_set_server_credentials_file(gnutls_srp_server_credentials_t /** * gnutls_srp_set_server_credentials_function - Used to set a callback to retrieve the user's SRP credentials - * @cred: is a &gnutls_srp_server_credentials_t structure. + * @cred: is a #gnutls_srp_server_credentials_t structure. * @func: is the callback function * * This function can be used to set a callback to retrieve the user's SRP credentials. @@ -579,7 +579,7 @@ gnutls_srp_set_server_credentials_function(gnutls_srp_server_credentials_t /** * gnutls_srp_set_client_credentials_function - Used to set a callback to retrieve the username and password - * @cred: is a &gnutls_srp_server_credentials_t structure. + * @cred: is a #gnutls_srp_server_credentials_t structure. * @func: is the callback function * * This function can be used to set a callback to retrieve the username and diff --git a/lib/gnutls_state.c b/lib/gnutls_state.c index 0157f928e0..108e34870a 100644 --- a/lib/gnutls_state.c +++ b/lib/gnutls_state.c @@ -55,7 +55,7 @@ void _gnutls_session_cert_type_set(gnutls_session_t session, /** * gnutls_cipher_get - Returns the currently used cipher. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the currently used cipher. **/ @@ -66,7 +66,7 @@ gnutls_cipher_algorithm_t gnutls_cipher_get(gnutls_session_t session) /** * gnutls_certificate_type_get - Returns the currently used certificate type. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the currently used certificate type. The certificate type * is by default X.509, unless it is negotiated as a TLS extension. @@ -80,7 +80,7 @@ gnutls_certificate_type_t gnutls_certificate_type_get(gnutls_session_t /** * gnutls_kx_get - Returns the key exchange algorithm. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the key exchange algorithm used in the last handshake. **/ @@ -91,7 +91,7 @@ gnutls_kx_algorithm_t gnutls_kx_get(gnutls_session_t session) /** * gnutls_mac_get - Returns the currently used mac algorithm. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the currently used mac algorithm. **/ @@ -102,7 +102,7 @@ gnutls_mac_algorithm_t gnutls_mac_get(gnutls_session_t session) /** * gnutls_compression_get - Returns the currently used compression algorithm. - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * Returns the currently used compression method. **/ @@ -215,7 +215,7 @@ void _gnutls_handshake_internal_state_clear(gnutls_session_t session) * gnutls_init - This function initializes the session to null (null encryption etc...). * @con_end: is used to indicate if this session is to be used for server or * client. Can be one of GNUTLS_CLIENT and GNUTLS_SERVER. - * @session: is a pointer to a &gnutls_session_t structure. + * @session: is a pointer to a #gnutls_session_t structure. * * This function initializes the current session to null. Every session * must be initialized before use, so internal structures can be allocated. @@ -321,10 +321,10 @@ int _gnutls_session_is_resumable(gnutls_session_t session) /** - * gnutls_deinit - This function clears all buffers associated with the &session - * @session: is a &gnutls_session_t structure. + * gnutls_deinit - This function clears all buffers associated with a session + * @session: is a #gnutls_session_t structure. * - * This function clears all buffers associated with the &session. + * This function clears all buffers associated with the @session. * This function will also remove session data from the session database * if the session was terminated abnormally. * @@ -567,7 +567,7 @@ int _gnutls_dh_set_group(gnutls_session_t session, mpi_t gen, mpi_t prime) /** * gnutls_openpgp_send_key - This function will order gnutls to send the openpgp fingerprint instead of the key - * @session: is a pointer to a &gnutls_session_t structure. + * @session: is a pointer to a #gnutls_session_t structure. * @status: is one of OPENPGP_KEY, or OPENPGP_KEY_FINGERPRINT * * This function will order gnutls to send the key fingerprint instead @@ -584,7 +584,7 @@ void gnutls_openpgp_send_key(gnutls_session_t session, /** * gnutls_certificate_send_x509_rdn_sequence - This function will order gnutls to or not to send the x.509 rdn sequence - * @session: is a pointer to a &gnutls_session_t structure. + * @session: is a pointer to a #gnutls_session_t structure. * @status: is 0 or 1 * * If status is non zero, this function will order gnutls not to send the rdnSequence @@ -609,7 +609,7 @@ int _gnutls_openpgp_send_fingerprint(gnutls_session_t session) /*- * _gnutls_record_set_default_version - Used to set the default version for the first record packet - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @major: is a tls major version * @minor: is a tls minor version * @@ -628,7 +628,7 @@ void _gnutls_record_set_default_version(gnutls_session_t session, /** * gnutls_handshake_set_private_extensions - Used to enable the private cipher suites - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @allow: is an integer (0 or 1) * * This function will enable or disable the use of private @@ -820,7 +820,7 @@ int _gnutls_PRF(const opaque * secret, int secret_size, const char *label, /** * gnutls_session_is_resumed - Used to check whether this session is a resumed one - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function will return non zero if this session is a resumed one, * or a zero if this is a new session. @@ -847,7 +847,7 @@ int gnutls_session_is_resumed(gnutls_session_t session) /*- * _gnutls_session_is_export - Used to check whether this session is of export grade - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function will return non zero if this session is of export grade. * @@ -868,7 +868,7 @@ int _gnutls_session_is_export(gnutls_session_t session) /** * gnutls_session_get_ptr - Used to get the user pointer from the session structure - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function will return the user given pointer from the session structure. * This is the pointer set with gnutls_session_set_ptr(). @@ -881,7 +881,7 @@ void *gnutls_session_get_ptr(gnutls_session_t session) /** * gnutls_session_set_ptr - Used to set the user pointer to the session structure - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @ptr: is the user pointer * * This function will set (associate) the user given pointer to the @@ -897,7 +897,7 @@ void gnutls_session_set_ptr(gnutls_session_t session, void *ptr) /** * gnutls_record_get_direction - This function will return the direction of the last interrupted function call - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * * This function provides information about the internals of the record * protocol and is only useful if a prior gnutls function call (e.g. @@ -917,7 +917,7 @@ int gnutls_record_get_direction(gnutls_session_t session) /*- * _gnutls_rsa_pms_set_version - Sets a version to be used at the RSA PMS - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @major: is the major version to use * @minor: is the minor version to use * diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c index ed77d1e599..d135817ccb 100644 --- a/lib/gnutls_ui.c +++ b/lib/gnutls_ui.c @@ -37,7 +37,7 @@ /** * gnutls_dh_set_prime_bits - Used to set the bits for a DH ciphersuite - * @session: is a &gnutls_session_t structure. + * @session: is a #gnutls_session_t structure. * @bits: is the number of bits * * This function sets the number of bits, for use in an diff --git a/lib/gnutls_x509.c b/lib/gnutls_x509.c index 537b84c3e3..57473ae994 100644 --- a/lib/gnutls_x509.c +++ b/lib/gnutls_x509.c @@ -837,7 +837,7 @@ static int read_key_file(gnutls_certificate_credentials_t res, /** * gnutls_certificate_set_x509_key_mem - Used to set keys in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @cert: contains a certificate list (path) for the specified private key * @key: is the private key * @type: is PEM or DER @@ -888,7 +888,7 @@ int gnutls_certificate_set_x509_key_mem(gnutls_certificate_credentials_t /** * gnutls_certificate_set_x509_key - Used to set keys in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @cert_list: contains a certificate list (path) for the specified private key * @cert_list_size: holds the size of the certificate list * @key: is a gnutls_x509_privkey_t key @@ -966,7 +966,7 @@ int gnutls_certificate_set_x509_key(gnutls_certificate_credentials_t res, /** * gnutls_certificate_set_x509_key_file - Used to set keys in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @CERTFILE: is a file that containing the certificate list (path) for * the specified private key, in PKCS7 format, or a list of certificates * @KEYFILE: is a file that contains the private key @@ -1253,7 +1253,7 @@ static int parse_der_ca_mem(gnutls_x509_crt_t ** cert_list, uint * ncerts, /** * gnutls_certificate_set_x509_trust_mem - Used to add trusted CAs in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @ca: is a list of trusted CAs or a DER certificate * @type: is DER or PEM * @@ -1292,7 +1292,7 @@ int gnutls_certificate_set_x509_trust_mem(gnutls_certificate_credentials_t /** * gnutls_certificate_set_x509_trust - Used to add trusted CAs in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @ca_list: is a list of trusted CAs * @ca_list_size: holds the size of the CA list * @@ -1349,7 +1349,7 @@ int gnutls_certificate_set_x509_trust(gnutls_certificate_credentials_t res, /** * gnutls_certificate_set_x509_trust_file - Used to add trusted CAs in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @cafile: is a file containing the list of trusted CAs (DER or PEM list) * @type: is PEM or DER * @@ -1559,7 +1559,7 @@ int read_crl_mem(gnutls_certificate_credentials_t res, const void *crl, /** * gnutls_certificate_set_x509_crl_mem - Used to add CRLs in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @CRL: is a list of trusted CRLs. They should have been verified before. * @type: is DER or PEM * @@ -1587,7 +1587,7 @@ int gnutls_certificate_set_x509_crl_mem(gnutls_certificate_credentials_t /** * gnutls_certificate_set_x509_crl - Used to add CRLs in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @crl_list: is a list of trusted CRLs. They should have been verified before. * @crl_list_size: holds the size of the crl_list * @@ -1630,7 +1630,7 @@ int gnutls_certificate_set_x509_crl(gnutls_certificate_credentials_t res, /** * gnutls_certificate_set_x509_crl_file - Used to add CRLs in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @crlfile: is a file containing the list of verified CRLs (DER or PEM list) * @type: is PEM or DER * @@ -1677,7 +1677,7 @@ int gnutls_certificate_set_x509_crl_file(gnutls_certificate_credentials_t /** * gnutls_certificate_free_crls - Used to free all the CRLs from a gnutls_certificate_credentials_t structure - * @sc: is an &gnutls_certificate_credentials_t structure. + * @sc: is an #gnutls_certificate_credentials_t structure. * * This function will delete all the CRLs associated * with the given credentials. diff --git a/lib/minitasn1/structure.c b/lib/minitasn1/structure.c index f33665476d..d5d2b2d98e 100644 --- a/lib/minitasn1/structure.c +++ b/lib/minitasn1/structure.c @@ -571,7 +571,7 @@ _asn1_expand_identifier(node_asn **node,node_asn *root) * ASN1_ELEMENT_NOT_FOUND\: SOURCE_NAME isn't known * * Example: using "pkix.asn" - * result=asn1_create_structure(cert_def,"PKIX1.Certificate",&cert); + * result=asn1_create_structure(cert_def,"PKIX1.Certificate",&cert); **/ asn1_retCode asn1_create_element(ASN1_TYPE definitions,const char *source_name, diff --git a/libextra/gnutls_openpgp.c b/libextra/gnutls_openpgp.c index 2eb291cec0..97d21f4904 100644 --- a/libextra/gnutls_openpgp.c +++ b/libextra/gnutls_openpgp.c @@ -1104,7 +1104,7 @@ int _gnutls_openpgp_key_to_gcert(gnutls_cert * gcert, /** * gnutls_certificate_set_openpgp_key - Used to set keys in a gnutls_certificate_credentials_t structure - * @res: is an &gnutls_certificate_credentials_t structure. + * @res: is an #gnutls_certificate_credentials_t structure. * @key: contains an openpgp public key * @pkey: is an openpgp private key * |